Open Connector API (1.0)

Download OpenAPI specification:Download

Conduction: info@conduction.nl URL: https://conduction.nl License: EUPL 1.2

API for managing connections between systems and data sources

The Open Connector API provides endpoints for managing connections between systems, mapping data between different formats, and synchronizing data between sources.

Endpoints

Manage API endpoints

List all endpoints

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"endpoint": "string",
"endpointArray": ["string"
],
"endpointRegex": "string",
"method": "GET",
"targetType": "string",
"targetId": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"rules": ["string"
]
}
]

Create a new endpoint

Request Body schema: application/json
required

id	integer or null Numeric identifier for the endpoint
uuid	string <uuid> Universally unique identifier for the endpoint
name required	string Name of the endpoint
description	string Description of the endpoint
reference	string Reference identifier for the endpoint
version	string Version of the endpoint
endpoint required	string URL path of the endpoint
endpointArray	Array of strings Array of endpoint path segments
endpointRegex	string Regular expression pattern for the endpoint
method required	string Enum: "GET" "POST" "PUT" "DELETE" "PATCH" HTTP method for the endpoint
targetType	string Type of target for the endpoint
targetId	string ID of the target for the endpoint
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp
rules	Array of strings Array of rule IDs associated with this endpoint

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"endpoint": "string",
"endpointArray": ["string"
],
"endpointRegex": "string",
"method": "GET",
"targetType": "string",
"targetId": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"rules": ["string"
]
}

Response samples

201

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"endpoint": "string",
"endpointArray": ["string"
],
"endpointRegex": "string",
"method": "GET",
"targetType": "string",
"targetId": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"rules": ["string"
]
}

Get endpoint details

path Parameters

id

required

string

Endpoint ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"endpoint": "string",
"endpointArray": ["string"
],
"endpointRegex": "string",
"method": "GET",
"targetType": "string",
"targetId": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"rules": ["string"
]
}

Update an endpoint

path Parameters

id

required

string

Endpoint ID

Request Body schema: application/json
required

id	integer or null Numeric identifier for the endpoint
uuid	string <uuid> Universally unique identifier for the endpoint
name required	string Name of the endpoint
description	string Description of the endpoint
reference	string Reference identifier for the endpoint
version	string Version of the endpoint
endpoint required	string URL path of the endpoint
endpointArray	Array of strings Array of endpoint path segments
endpointRegex	string Regular expression pattern for the endpoint
method required	string Enum: "GET" "POST" "PUT" "DELETE" "PATCH" HTTP method for the endpoint
targetType	string Type of target for the endpoint
targetId	string ID of the target for the endpoint
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp
rules	Array of strings Array of rule IDs associated with this endpoint

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"endpoint": "string",
"endpointArray": ["string"
],
"endpointRegex": "string",
"method": "GET",
"targetType": "string",
"targetId": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"rules": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"endpoint": "string",
"endpointArray": ["string"
],
"endpointRegex": "string",
"method": "GET",
"targetType": "string",
"targetId": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"rules": ["string"
]
}

Delete an endpoint

path Parameters

id

required

string

Endpoint ID

Responses

Test an endpoint

path Parameters

id

required

string

Endpoint ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": { }
}

Get endpoint logs

path Parameters

id

required

string

Endpoint ID

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"type": "in",
"callId": "4722cd84-0ec7-4ef5-8c34-1b0150f45f53",
"requestMethod": "string",
"requestHeaders": [{ }
],
"requestQuery": [{ }
],
"requestPathInfo": "string",
"requestLanguages": ["string"
],
"requestServer": { },
"requestContent": "string",
"responseStatus": "string",
"responseStatusCode": 0,
"responseHeaders": [{ }
],
"responseContent": "string",
"userId": "string",
"session": "string",
"sessionValues": { },
"responseTime": 0,
"routeName": "string",
"routeParameters": { },
"entity": { },
"endpoint": { },
"gateway": { },
"handler": { },
"objectId": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}
]

Handle GET request to an endpoint

path Parameters

_path

required

string

Path to the endpoint

Responses

Response samples

200

Content type

application/json

{ }

Handle POST request to an endpoint

path Parameters

_path

required

string

Path to the endpoint

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Handle PUT request to an endpoint

path Parameters

_path

required

string

Path to the endpoint

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Handle PATCH request to an endpoint

path Parameters

_path

required

string

Path to the endpoint

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Handle DELETE request to an endpoint

path Parameters

_path

required

string

Path to the endpoint

Responses

Response samples

200

Content type

application/json

{ }

Sources

Manage data sources

List all sources

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"location": "string",
"isEnabled": true,
"type": "json",
"authorizationHeader": "string",
"auth": "apikey",
"authenticationConfig": { },
"authorizationPassthroughMethod": "header",
"locale": "string",
"accept": "string",
"jwt": "string",
"jwtId": "string",
"secret": "string",
"username": "string",
"password": "string",
"apikey": "string",
"documentation": "string",
"loggingConfig": { },
"oas": [{ }
],
"paths": [{ }
],
"headers": [{ }
],
"translationConfig": [{ }
],
"configuration": { },
"endpointsConfig": { }
}
]

Create a new source

Request Body schema: application/json
required

id	string or null Identifier for the source
uuid	string <uuid> Universally unique identifier for the source
name required	string Name of the source
description	string Description of the source
reference	string Reference identifier for the source
version	string Version of the source
location	string URL or location of the source
isEnabled	boolean Whether the source is enabled
type required	string Enum: "json" "xml" "soap" "ftp" "sftp" "api" "database" "file" Type of the source
authorizationHeader	string Authorization header for the source
auth	string Enum: "apikey" "jwt" "username-password" "none" "jwt-HS256" "vrijbrp-jwt" "pink-jwt" "oauth" Authentication method for the source
authenticationConfig	object Authentication configuration for the source
authorizationPassthroughMethod	string Enum: "header" "query" "form_params" "json" "base_auth" Method for passing through authorization
locale	string Locale for the source
accept	string Accept header for the source
jwt	string JWT token for the source
jwtId	string JWT ID for the source
secret	string Secret for the source
username	string Username for the source
password	string Password for the source
apikey	string API key for the source
documentation	string Documentation for the source
loggingConfig	object Logging configuration for the source
oas	Array of objects OpenAPI specification for the source
paths	Array of objects Paths for the source
headers	Array of objects Headers for the source
translationConfig	Array of objects Translation configuration for the source
configuration	object General configuration for the source
endpointsConfig	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"location": "string",
"isEnabled": true,
"type": "json",
"authorizationHeader": "string",
"auth": "apikey",
"authenticationConfig": { },
"authorizationPassthroughMethod": "header",
"locale": "string",
"accept": "string",
"jwt": "string",
"jwtId": "string",
"secret": "string",
"username": "string",
"password": "string",
"apikey": "string",
"documentation": "string",
"loggingConfig": { },
"oas": [{ }
],
"paths": [{ }
],
"headers": [{ }
],
"translationConfig": [{ }
],
"configuration": { },
"endpointsConfig": { }
}

Response samples

201

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"location": "string",
"isEnabled": true,
"type": "json",
"authorizationHeader": "string",
"auth": "apikey",
"authenticationConfig": { },
"authorizationPassthroughMethod": "header",
"locale": "string",
"accept": "string",
"jwt": "string",
"jwtId": "string",
"secret": "string",
"username": "string",
"password": "string",
"apikey": "string",
"documentation": "string",
"loggingConfig": { },
"oas": [{ }
],
"paths": [{ }
],
"headers": [{ }
],
"translationConfig": [{ }
],
"configuration": { },
"endpointsConfig": { }
}

Get source details

path Parameters

id

required

string

Source ID

Responses

Response samples

200

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"location": "string",
"isEnabled": true,
"type": "json",
"authorizationHeader": "string",
"auth": "apikey",
"authenticationConfig": { },
"authorizationPassthroughMethod": "header",
"locale": "string",
"accept": "string",
"jwt": "string",
"jwtId": "string",
"secret": "string",
"username": "string",
"password": "string",
"apikey": "string",
"documentation": "string",
"loggingConfig": { },
"oas": [{ }
],
"paths": [{ }
],
"headers": [{ }
],
"translationConfig": [{ }
],
"configuration": { },
"endpointsConfig": { }
}

Update a source

path Parameters

id

required

string

Source ID

Request Body schema: application/json
required

id	string or null Identifier for the source
uuid	string <uuid> Universally unique identifier for the source
name required	string Name of the source
description	string Description of the source
reference	string Reference identifier for the source
version	string Version of the source
location	string URL or location of the source
isEnabled	boolean Whether the source is enabled
type required	string Enum: "json" "xml" "soap" "ftp" "sftp" "api" "database" "file" Type of the source
authorizationHeader	string Authorization header for the source
auth	string Enum: "apikey" "jwt" "username-password" "none" "jwt-HS256" "vrijbrp-jwt" "pink-jwt" "oauth" Authentication method for the source
authenticationConfig	object Authentication configuration for the source
authorizationPassthroughMethod	string Enum: "header" "query" "form_params" "json" "base_auth" Method for passing through authorization
locale	string Locale for the source
accept	string Accept header for the source
jwt	string JWT token for the source
jwtId	string JWT ID for the source
secret	string Secret for the source
username	string Username for the source
password	string Password for the source
apikey	string API key for the source
documentation	string Documentation for the source
loggingConfig	object Logging configuration for the source
oas	Array of objects OpenAPI specification for the source
paths	Array of objects Paths for the source
headers	Array of objects Headers for the source
translationConfig	Array of objects Translation configuration for the source
configuration	object General configuration for the source
endpointsConfig	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"location": "string",
"isEnabled": true,
"type": "json",
"authorizationHeader": "string",
"auth": "apikey",
"authenticationConfig": { },
"authorizationPassthroughMethod": "header",
"locale": "string",
"accept": "string",
"jwt": "string",
"jwtId": "string",
"secret": "string",
"username": "string",
"password": "string",
"apikey": "string",
"documentation": "string",
"loggingConfig": { },
"oas": [{ }
],
"paths": [{ }
],
"headers": [{ }
],
"translationConfig": [{ }
],
"configuration": { },
"endpointsConfig": { }
}

Response samples

200

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"reference": "string",
"version": "string",
"location": "string",
"isEnabled": true,
"type": "json",
"authorizationHeader": "string",
"auth": "apikey",
"authenticationConfig": { },
"authorizationPassthroughMethod": "header",
"locale": "string",
"accept": "string",
"jwt": "string",
"jwtId": "string",
"secret": "string",
"username": "string",
"password": "string",
"apikey": "string",
"documentation": "string",
"loggingConfig": { },
"oas": [{ }
],
"paths": [{ }
],
"headers": [{ }
],
"translationConfig": [{ }
],
"configuration": { },
"endpointsConfig": { }
}

Delete a source

path Parameters

id

required

string

Source ID

Responses

Test a source connection

path Parameters

id

required

string

Source ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": { }
}

Get source logs

path Parameters

id

required

string

Source ID

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"sourceId": "string",
"endpoint": "string",
"method": "GET",
"statusCode": 0,
"requestHeaders": { },
"requestBody": { },
"responseHeaders": { },
"responseBody": { },
"duration": 0,
"error": "string",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
]

Mappings

Manage data mappings

List all mappings

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"reference": "string",
"version": "string",
"name": "string",
"description": "string",
"mapping": { },
"unset": ["string"
],
"cast": { },
"passThrough": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}
]

Create a new mapping

Request Body schema: application/json
required

id	integer or null Numeric identifier for the mapping
uuid	string <uuid> Universally unique identifier for the mapping
reference	string Reference identifier for the mapping
version	string Version of the mapping
name required	string Name of the mapping
description	string Description of the mapping
mapping required	object The actual mapping configuration
unset	Array of strings Fields to unset during mapping
cast	object Type casting configuration
passThrough	boolean Whether to pass through unmapped fields
dateCreated	string <date-time> Creation timestamp
dateModified	string <date-time> Last modification timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"reference": "string",
"version": "string",
"name": "string",
"description": "string",
"mapping": { },
"unset": ["string"
],
"cast": { },
"passThrough": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"reference": "string",
"version": "string",
"name": "string",
"description": "string",
"mapping": { },
"unset": ["string"
],
"cast": { },
"passThrough": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Get mapping details

path Parameters

id

required

string

Mapping ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"reference": "string",
"version": "string",
"name": "string",
"description": "string",
"mapping": { },
"unset": ["string"
],
"cast": { },
"passThrough": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Update a mapping

path Parameters

id

required

string

Mapping ID

Request Body schema: application/json
required

id	integer or null Numeric identifier for the mapping
uuid	string <uuid> Universally unique identifier for the mapping
reference	string Reference identifier for the mapping
version	string Version of the mapping
name required	string Name of the mapping
description	string Description of the mapping
mapping required	object The actual mapping configuration
unset	Array of strings Fields to unset during mapping
cast	object Type casting configuration
passThrough	boolean Whether to pass through unmapped fields
dateCreated	string <date-time> Creation timestamp
dateModified	string <date-time> Last modification timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"reference": "string",
"version": "string",
"name": "string",
"description": "string",
"mapping": { },
"unset": ["string"
],
"cast": { },
"passThrough": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"reference": "string",
"version": "string",
"name": "string",
"description": "string",
"mapping": { },
"unset": ["string"
],
"cast": { },
"passThrough": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
}

Delete a mapping

path Parameters

id

required

string

Mapping ID

Responses

Test a mapping

Request Body schema: application/json
required

	object (Mapping) Represents a data mapping configuration
data	object Data to test the mapping with

Responses

Request samples

Payload

Content type

application/json

{"mapping": {"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"reference": "string",
"version": "string",
"name": "string",
"description": "string",
"mapping": { },
"unset": ["string"
],
"cast": { },
"passThrough": true,
"dateCreated": "2019-08-24T14:15:22Z",
"dateModified": "2019-08-24T14:15:22Z"
},
"data": { }
}

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": { }
}

Get mapping objects

Responses

Response samples

200

Content type

application/json

[{ }
]

Save mapping object

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{ }

Jobs

Manage scheduled jobs

List all jobs

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"jobClass": "string",
"arguments": { },
"interval": 0,
"executionTime": 0,
"timeSensitive": true,
"allowParallelRuns": true,
"isEnabled": true,
"singleRun": true,
"scheduleAfter": "string",
"userId": "string",
"jobListId": "string",
"logRetention": 0,
"errorRetention": 0,
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string"
}
]

Create a new job

Request Body schema: application/json
required

id	string Identifier for the job
name required	string Name of the job
description	string Description of the job
jobClass required	string Class that implements the job
arguments	object Arguments for the job
interval	integer Interval in seconds between job runs
executionTime	integer Maximum execution time in seconds
timeSensitive	boolean Whether the job is time-sensitive
allowParallelRuns	boolean Whether parallel runs are allowed
isEnabled	boolean Whether the job is enabled
singleRun	boolean Whether the job should run only once
scheduleAfter	string When to schedule the job after
userId	string User ID associated with the job
jobListId	string Job list ID
logRetention	integer Log retention period in seconds
errorRetention	integer Error retention period in seconds
lastRun	string <date-time> Last run timestamp
nextRun	string <date-time> Next run timestamp
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp
version	string Version of the job

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"jobClass": "string",
"arguments": { },
"interval": 0,
"executionTime": 0,
"timeSensitive": true,
"allowParallelRuns": true,
"isEnabled": true,
"singleRun": true,
"scheduleAfter": "string",
"userId": "string",
"jobListId": "string",
"logRetention": 0,
"errorRetention": 0,
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"jobClass": "string",
"arguments": { },
"interval": 0,
"executionTime": 0,
"timeSensitive": true,
"allowParallelRuns": true,
"isEnabled": true,
"singleRun": true,
"scheduleAfter": "string",
"userId": "string",
"jobListId": "string",
"logRetention": 0,
"errorRetention": 0,
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string"
}

Get job details

path Parameters

id

required

string

Job ID

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"jobClass": "string",
"arguments": { },
"interval": 0,
"executionTime": 0,
"timeSensitive": true,
"allowParallelRuns": true,
"isEnabled": true,
"singleRun": true,
"scheduleAfter": "string",
"userId": "string",
"jobListId": "string",
"logRetention": 0,
"errorRetention": 0,
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string"
}

Update a job

path Parameters

id

required

string

Job ID

Request Body schema: application/json
required

id	string Identifier for the job
name required	string Name of the job
description	string Description of the job
jobClass required	string Class that implements the job
arguments	object Arguments for the job
interval	integer Interval in seconds between job runs
executionTime	integer Maximum execution time in seconds
timeSensitive	boolean Whether the job is time-sensitive
allowParallelRuns	boolean Whether parallel runs are allowed
isEnabled	boolean Whether the job is enabled
singleRun	boolean Whether the job should run only once
scheduleAfter	string When to schedule the job after
userId	string User ID associated with the job
jobListId	string Job list ID
logRetention	integer Log retention period in seconds
errorRetention	integer Error retention period in seconds
lastRun	string <date-time> Last run timestamp
nextRun	string <date-time> Next run timestamp
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp
version	string Version of the job

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"jobClass": "string",
"arguments": { },
"interval": 0,
"executionTime": 0,
"timeSensitive": true,
"allowParallelRuns": true,
"isEnabled": true,
"singleRun": true,
"scheduleAfter": "string",
"userId": "string",
"jobListId": "string",
"logRetention": 0,
"errorRetention": 0,
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"jobClass": "string",
"arguments": { },
"interval": 0,
"executionTime": 0,
"timeSensitive": true,
"allowParallelRuns": true,
"isEnabled": true,
"singleRun": true,
"scheduleAfter": "string",
"userId": "string",
"jobListId": "string",
"logRetention": 0,
"errorRetention": 0,
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string"
}

Delete a job

path Parameters

id

required

string

Job ID

Responses

Test a job

path Parameters

id

required

string

Job ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": { }
}

Get job logs

path Parameters

id

required

string

Job ID

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"level": "string",
"message": "string",
"jobId": "string",
"jobListId": "string",
"jobClass": "string",
"arguments": { },
"executionTime": 0,
"userId": "string",
"sessionId": "string",
"stackTrace": [{ }
],
"expires": "string",
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z"
}
]

Synchronizations

Manage data synchronizations

List all synchronizations

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"conditions": "string",
"sourceId": "string",
"sourceType": "string",
"sourceHash": "string",
"sourceHashMapping": "string",
"sourceTargetMapping": "string",
"sourceConfig": {"property1": "string",
"property2": "string"
},
"sourceLastChanged": "2019-08-24T14:15:22Z",
"sourceLastChecked": "2019-08-24T14:15:22Z",
"sourceLastSynced": "2019-08-24T14:15:22Z",
"targetId": "string",
"targetType": "string",
"targetHash": "string",
"targetSourceMapping": "string",
"targetConfig": {"property1": "string",
"property2": "string"
},
"targetLastChanged": "2019-08-24T14:15:22Z",
"targetLastChecked": "2019-08-24T14:15:22Z",
"targetLastSynced": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string",
"actions": ["string"
]
}
]

Create a new synchronization

Request Body schema: application/json
required

id	integer or null Numeric identifier for the synchronization
uuid	string <uuid> Universally unique identifier for the synchronization
name required	string Name of the synchronization
description	string Description of the synchronization
conditions	string Conditions for synchronization
sourceId required	string ID of the source
sourceType	string Type of the source
sourceHash	string Hash of the source data
sourceHashMapping	string Mapping for source hash
sourceTargetMapping	string Mapping from source to target
	object Source configuration
sourceLastChanged	string <date-time> When the source was last changed
sourceLastChecked	string <date-time> When the source was last checked
sourceLastSynced	string <date-time> When the source was last synced
targetId required	string ID of the target
targetType	string Type of the target
targetHash	string Hash of the target data
targetSourceMapping	string Mapping from target to source
	object Target configuration
targetLastChanged	string <date-time> When the target was last changed
targetLastChecked	string <date-time> When the target was last checked
targetLastSynced	string <date-time> When the target was last synced
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp
version	string Version of the synchronization
actions	Array of strings Actions to perform during synchronization

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"conditions": "string",
"sourceId": "string",
"sourceType": "string",
"sourceHash": "string",
"sourceHashMapping": "string",
"sourceTargetMapping": "string",
"sourceConfig": {"property1": "string",
"property2": "string"
},
"sourceLastChanged": "2019-08-24T14:15:22Z",
"sourceLastChecked": "2019-08-24T14:15:22Z",
"sourceLastSynced": "2019-08-24T14:15:22Z",
"targetId": "string",
"targetType": "string",
"targetHash": "string",
"targetSourceMapping": "string",
"targetConfig": {"property1": "string",
"property2": "string"
},
"targetLastChanged": "2019-08-24T14:15:22Z",
"targetLastChecked": "2019-08-24T14:15:22Z",
"targetLastSynced": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string",
"actions": ["string"
]
}

Response samples

201

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"conditions": "string",
"sourceId": "string",
"sourceType": "string",
"sourceHash": "string",
"sourceHashMapping": "string",
"sourceTargetMapping": "string",
"sourceConfig": {"property1": "string",
"property2": "string"
},
"sourceLastChanged": "2019-08-24T14:15:22Z",
"sourceLastChecked": "2019-08-24T14:15:22Z",
"sourceLastSynced": "2019-08-24T14:15:22Z",
"targetId": "string",
"targetType": "string",
"targetHash": "string",
"targetSourceMapping": "string",
"targetConfig": {"property1": "string",
"property2": "string"
},
"targetLastChanged": "2019-08-24T14:15:22Z",
"targetLastChecked": "2019-08-24T14:15:22Z",
"targetLastSynced": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string",
"actions": ["string"
]
}

Get synchronization details

path Parameters

id

required

string

Synchronization ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"conditions": "string",
"sourceId": "string",
"sourceType": "string",
"sourceHash": "string",
"sourceHashMapping": "string",
"sourceTargetMapping": "string",
"sourceConfig": {"property1": "string",
"property2": "string"
},
"sourceLastChanged": "2019-08-24T14:15:22Z",
"sourceLastChecked": "2019-08-24T14:15:22Z",
"sourceLastSynced": "2019-08-24T14:15:22Z",
"targetId": "string",
"targetType": "string",
"targetHash": "string",
"targetSourceMapping": "string",
"targetConfig": {"property1": "string",
"property2": "string"
},
"targetLastChanged": "2019-08-24T14:15:22Z",
"targetLastChecked": "2019-08-24T14:15:22Z",
"targetLastSynced": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string",
"actions": ["string"
]
}

Update a synchronization

path Parameters

id

required

string

Synchronization ID

Request Body schema: application/json
required

id	integer or null Numeric identifier for the synchronization
uuid	string <uuid> Universally unique identifier for the synchronization
name required	string Name of the synchronization
description	string Description of the synchronization
conditions	string Conditions for synchronization
sourceId required	string ID of the source
sourceType	string Type of the source
sourceHash	string Hash of the source data
sourceHashMapping	string Mapping for source hash
sourceTargetMapping	string Mapping from source to target
	object Source configuration
sourceLastChanged	string <date-time> When the source was last changed
sourceLastChecked	string <date-time> When the source was last checked
sourceLastSynced	string <date-time> When the source was last synced
targetId required	string ID of the target
targetType	string Type of the target
targetHash	string Hash of the target data
targetSourceMapping	string Mapping from target to source
	object Target configuration
targetLastChanged	string <date-time> When the target was last changed
targetLastChecked	string <date-time> When the target was last checked
targetLastSynced	string <date-time> When the target was last synced
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp
version	string Version of the synchronization
actions	Array of strings Actions to perform during synchronization

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"conditions": "string",
"sourceId": "string",
"sourceType": "string",
"sourceHash": "string",
"sourceHashMapping": "string",
"sourceTargetMapping": "string",
"sourceConfig": {"property1": "string",
"property2": "string"
},
"sourceLastChanged": "2019-08-24T14:15:22Z",
"sourceLastChecked": "2019-08-24T14:15:22Z",
"sourceLastSynced": "2019-08-24T14:15:22Z",
"targetId": "string",
"targetType": "string",
"targetHash": "string",
"targetSourceMapping": "string",
"targetConfig": {"property1": "string",
"property2": "string"
},
"targetLastChanged": "2019-08-24T14:15:22Z",
"targetLastChecked": "2019-08-24T14:15:22Z",
"targetLastSynced": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string",
"actions": ["string"
]
}

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"conditions": "string",
"sourceId": "string",
"sourceType": "string",
"sourceHash": "string",
"sourceHashMapping": "string",
"sourceTargetMapping": "string",
"sourceConfig": {"property1": "string",
"property2": "string"
},
"sourceLastChanged": "2019-08-24T14:15:22Z",
"sourceLastChecked": "2019-08-24T14:15:22Z",
"sourceLastSynced": "2019-08-24T14:15:22Z",
"targetId": "string",
"targetType": "string",
"targetHash": "string",
"targetSourceMapping": "string",
"targetConfig": {"property1": "string",
"property2": "string"
},
"targetLastChanged": "2019-08-24T14:15:22Z",
"targetLastChecked": "2019-08-24T14:15:22Z",
"targetLastSynced": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"version": "string",
"actions": ["string"
]
}

Delete a synchronization

path Parameters

id

required

string

Synchronization ID

Responses

Get synchronization contracts

path Parameters

id

required

string

Synchronization ID

Responses

Response samples

200

Content type

application/json

{ }

Get synchronization logs

path Parameters

uuid

required

string <uuid>

Synchronization UUID

Responses

Response samples

200

Content type

application/json

[{ }
]

Test a synchronization

path Parameters

id

required

string

Synchronization ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": { }
}

Run a synchronization

path Parameters

id

required

string

Synchronization ID

Responses

Response samples

200

Content type

application/json

{"success": true,
"message": "string",
"data": { }
}

Consumers

Manage API consumers

List all consumers

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"domains": ["string"
],
"ips": ["string"
],
"authorizationType": "none",
"authorizationConfiguration": [["string"
]
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
]

Create a new consumer

Request Body schema: application/json
required

id	integer or null Numeric identifier for the consumer
uuid	string <uuid> Universally unique identifier for the consumer
name required	string Name of the consumer
description	string Description of the consumer
domains	Array of strings Allowed domains for the consumer
ips	Array of strings Allowed IP addresses for the consumer
authorizationType required	string Enum: "none" "basic" "bearer" "apiKey" "oauth2" "jwt" Type of authorization for the consumer
authorizationConfiguration	Array of strings[ items ] Authorization configuration
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"domains": ["string"
],
"ips": ["string"
],
"authorizationType": "none",
"authorizationConfiguration": [["string"
]
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"domains": ["string"
],
"ips": ["string"
],
"authorizationType": "none",
"authorizationConfiguration": [["string"
]
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Get consumer details

path Parameters

id

required

string

Consumer ID

Responses

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"domains": ["string"
],
"ips": ["string"
],
"authorizationType": "none",
"authorizationConfiguration": [["string"
]
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Update a consumer

path Parameters

id

required

string

Consumer ID

Request Body schema: application/json
required

id	integer or null Numeric identifier for the consumer
uuid	string <uuid> Universally unique identifier for the consumer
name required	string Name of the consumer
description	string Description of the consumer
domains	Array of strings Allowed domains for the consumer
ips	Array of strings Allowed IP addresses for the consumer
authorizationType required	string Enum: "none" "basic" "bearer" "apiKey" "oauth2" "jwt" Type of authorization for the consumer
authorizationConfiguration	Array of strings[ items ] Authorization configuration
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"domains": ["string"
],
"ips": ["string"
],
"authorizationType": "none",
"authorizationConfiguration": [["string"
]
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"domains": ["string"
],
"ips": ["string"
],
"authorizationType": "none",
"authorizationConfiguration": [["string"
]
],
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Delete a consumer

path Parameters

id

required

string

Consumer ID

Responses

Rules

Manage business rules

List all rules

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"action": "create",
"timing": "before",
"conditions": [{ }
],
"type": "mapping",
"configuration": { },
"order": 0,
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
]

Create a new rule

Request Body schema: application/json
required

id	string Identifier for the rule
uuid	string <uuid> Universally unique identifier for the rule
name required	string Name of the rule
description	string Description of the rule
action required	string Enum: "create" "read" "update" "delete" Action the rule applies to
timing required	string Enum: "before" "after" When the rule should be applied
conditions	Array of objects Conditions for the rule in JSON Logic format
type required	string Enum: "mapping" "error" "script" "synchronization" Type of the rule
configuration	object Configuration for the rule
order	integer Order in which the rule should be applied
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"action": "create",
"timing": "before",
"conditions": [{ }
],
"type": "mapping",
"configuration": { },
"order": 0,
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"action": "create",
"timing": "before",
"conditions": [{ }
],
"type": "mapping",
"configuration": { },
"order": 0,
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Get rule details

path Parameters

id

required

string

Rule ID

Responses

Response samples

200

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"action": "create",
"timing": "before",
"conditions": [{ }
],
"type": "mapping",
"configuration": { },
"order": 0,
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Update a rule

path Parameters

id

required

string

Rule ID

Request Body schema: application/json
required

id	string Identifier for the rule
uuid	string <uuid> Universally unique identifier for the rule
name required	string Name of the rule
description	string Description of the rule
action required	string Enum: "create" "read" "update" "delete" Action the rule applies to
timing required	string Enum: "before" "after" When the rule should be applied
conditions	Array of objects Conditions for the rule in JSON Logic format
type required	string Enum: "mapping" "error" "script" "synchronization" Type of the rule
configuration	object Configuration for the rule
order	integer Order in which the rule should be applied
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"action": "create",
"timing": "before",
"conditions": [{ }
],
"type": "mapping",
"configuration": { },
"order": 0,
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": "string",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"name": "string",
"description": "string",
"action": "create",
"timing": "before",
"conditions": [{ }
],
"type": "mapping",
"configuration": { },
"order": 0,
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Delete a rule

path Parameters

id

required

string

Rule ID

Responses

Events

Manage events and event subscriptions

List all events

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"description": "string",
"eventType": "string",
"payload": { },
"priority": 1,
"timeout": 0,
"isAsync": true,
"allowDuplicates": true,
"isEnabled": true,
"oneTime": true,
"scheduleAfter": "string",
"userId": "string",
"eventGroupId": "string",
"retentionPeriod": 0,
"errorRetention": 0,
"lastTriggered": "2019-08-24T14:15:22Z",
"nextTrigger": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}
]

Create a new event

Request Body schema: application/json
required

id	string Identifier for the event
name required	string Name of the event
description	string Description of the event
eventType required	string Type of the event
payload	object Payload for the event
priority	integer [ 1 .. 10 ] Priority of the event
timeout	integer Timeout in seconds
isAsync	boolean Whether the event is asynchronous
allowDuplicates	boolean Whether duplicate events are allowed
isEnabled	boolean Whether the event is enabled
oneTime	boolean Whether the event should only be triggered once
scheduleAfter	string When to schedule the event after
userId	string User ID associated with the event
eventGroupId	string Event group ID
retentionPeriod	integer Retention period in seconds
errorRetention	integer Error retention period in seconds
lastTriggered	string <date-time> When the event was last triggered
nextTrigger	string <date-time> When the event will next be triggered
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"eventType": "string",
"payload": { },
"priority": 1,
"timeout": 0,
"isAsync": true,
"allowDuplicates": true,
"isEnabled": true,
"oneTime": true,
"scheduleAfter": "string",
"userId": "string",
"eventGroupId": "string",
"retentionPeriod": 0,
"errorRetention": 0,
"lastTriggered": "2019-08-24T14:15:22Z",
"nextTrigger": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"eventType": "string",
"payload": { },
"priority": 1,
"timeout": 0,
"isAsync": true,
"allowDuplicates": true,
"isEnabled": true,
"oneTime": true,
"scheduleAfter": "string",
"userId": "string",
"eventGroupId": "string",
"retentionPeriod": 0,
"errorRetention": 0,
"lastTriggered": "2019-08-24T14:15:22Z",
"nextTrigger": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Get event details

path Parameters

id

required

string

Event ID

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"eventType": "string",
"payload": { },
"priority": 1,
"timeout": 0,
"isAsync": true,
"allowDuplicates": true,
"isEnabled": true,
"oneTime": true,
"scheduleAfter": "string",
"userId": "string",
"eventGroupId": "string",
"retentionPeriod": 0,
"errorRetention": 0,
"lastTriggered": "2019-08-24T14:15:22Z",
"nextTrigger": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Update an event

path Parameters

id

required

string

Event ID

Request Body schema: application/json
required

id	string Identifier for the event
name required	string Name of the event
description	string Description of the event
eventType required	string Type of the event
payload	object Payload for the event
priority	integer [ 1 .. 10 ] Priority of the event
timeout	integer Timeout in seconds
isAsync	boolean Whether the event is asynchronous
allowDuplicates	boolean Whether duplicate events are allowed
isEnabled	boolean Whether the event is enabled
oneTime	boolean Whether the event should only be triggered once
scheduleAfter	string When to schedule the event after
userId	string User ID associated with the event
eventGroupId	string Event group ID
retentionPeriod	integer Retention period in seconds
errorRetention	integer Error retention period in seconds
lastTriggered	string <date-time> When the event was last triggered
nextTrigger	string <date-time> When the event will next be triggered
created	string <date-time> Creation timestamp
updated	string <date-time> Last update timestamp

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"eventType": "string",
"payload": { },
"priority": 1,
"timeout": 0,
"isAsync": true,
"allowDuplicates": true,
"isEnabled": true,
"oneTime": true,
"scheduleAfter": "string",
"userId": "string",
"eventGroupId": "string",
"retentionPeriod": 0,
"errorRetention": 0,
"lastTriggered": "2019-08-24T14:15:22Z",
"nextTrigger": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"description": "string",
"eventType": "string",
"payload": { },
"priority": 1,
"timeout": 0,
"isAsync": true,
"allowDuplicates": true,
"isEnabled": true,
"oneTime": true,
"scheduleAfter": "string",
"userId": "string",
"eventGroupId": "string",
"retentionPeriod": 0,
"errorRetention": 0,
"lastTriggered": "2019-08-24T14:15:22Z",
"nextTrigger": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z"
}

Delete an event

path Parameters

id

required

string

Event ID

Responses

Get event messages

path Parameters

id

required

string

Event ID

Responses

Response samples

200

Content type

application/json

[{ }
]

List all event subscriptions

Responses

Response samples

200

Content type

application/json

[{ }
]

Create a new event subscription

Request Body schema: application/json
required

eventId	string ID of the event to subscribe to
callbackUrl	string <uri> URL to call when the event is triggered

Responses

Request samples

Payload

Content type

application/json

{"eventId": "string",
"callbackUrl": "http://example.com"
}

Response samples

201

Content type

application/json

{ }

Update an event subscription

path Parameters

subscriptionId

required

string

Subscription ID

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{ }

Delete an event subscription

path Parameters

subscriptionId

required

string

Subscription ID

Responses

Get subscription messages

path Parameters

subscriptionId

required

string

Subscription ID

Responses

Response samples

200

Content type

application/json

[{ }
]

Pull messages for a subscription

path Parameters

subscriptionId

required

string

Subscription ID

Responses

Response samples

200

Content type

application/json

[{ }
]

Import/Export

Import and export configuration

Import configuration

Request Body schema: application/json
required

object

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json

{"success": true,
"message": "string"
}

Export configuration

path Parameters

type required	string Enum: "endpoint" "source" "mapping" "job" "synchronization" "consumer" "rule" "event" Type of configuration to export
id required	string ID of the configuration to export

Responses

Response samples

200

Content type

application/json

{ }

Open Connector API (1.0)

Endpoints

List all endpoints

Responses

Response samples

Create a new endpoint

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get endpoint details

path Parameters

Responses

Response samples

Update an endpoint

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an endpoint

path Parameters

Responses

Test an endpoint

path Parameters

Responses

Response samples

Get endpoint logs

path Parameters

Responses

Response samples

Handle GET request to an endpoint

path Parameters

Responses

Response samples

Handle POST request to an endpoint

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Handle PUT request to an endpoint

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Handle PATCH request to an endpoint

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Handle DELETE request to an endpoint

path Parameters

Responses

Response samples

Sources

List all sources

Responses

Response samples

Create a new source

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get source details

path Parameters

Responses

Response samples

Update a source

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a source

path Parameters

Responses

Test a source connection

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required