GENERIC

Generic integration operations

Retrieve a generic configuration

get

Returns the generic configuration for the integration instance with the specified ID.

Authorizations

AuthorizationstringOptional

Path parameters

ingestibleIdstring · uuidRequired

Responses

200

Generic configuration

application/json

idstring · uuidRequired

ingestibleIdstring · uuidRequired

valuestringRequired

403

Reading configuration is now allowed.

404

No configuration is found by specified ingestible id.

get/genericIntegration/{ingestibleId}/configuration

GET /rest/catalog/1.0/genericIntegration/{ingestibleId}/configuration HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "ingestibleId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "text"
}

Create or update a generic configuration

put

Creates or updates a generic configuration for the integration instance with the specified ID.

Authorizations

AuthorizationstringOptional

Path parameters

ingestibleIdstring · uuidRequired

Body

configurationstringRequired

Responses

200

Generic configuration is created or updated

application/json

idstring · uuidRequired

ingestibleIdstring · uuidRequired

valuestringRequired

400

Request body is invalid e.g. is not a JSON

403

Saving a configuration to the given instance is not allowed

404

No integration instance is found by specified ingestible id.

put/genericIntegration/{ingestibleId}/configuration

PUT /rest/catalog/1.0/genericIntegration/{ingestibleId}/configuration HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "configuration": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "ingestibleId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "text"
}

Delete a generic configuration

delete

Deletes a generic configuration from the integration instance with the specified ID.

Authorizations

AuthorizationstringOptional

Path parameters

ingestibleIdstring · uuidRequired

Responses

204

Generic configuration is deleted

application/json

idstring · uuidRequired

ingestibleIdstring · uuidRequired

valuestringRequired

403

Deleting a configuration is not allowed

404

No configuration is found by specified ingestible id.

delete/genericIntegration/{ingestibleId}/configuration

DELETE /rest/catalog/1.0/genericIntegration/{ingestibleId}/configuration HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "ingestibleId": "123e4567-e89b-12d3-a456-426614174000",
  "value": "text"
}

Retrieve data schema as part of generic configuration

get

Returns data schema for the integration instance with the specified ID.

Authorizations

AuthorizationstringOptional

Path parameters

ingestibleIdstring · uuidRequired

Responses

200

Data schema

application/json

stringOptional

404

No data schema is found by specified ingestible id.

get/genericIntegration/{ingestibleId}/configuration/schema

GET /rest/catalog/1.0/genericIntegration/{ingestibleId}/configuration/schema HTTP/1.1
Authorization: Basic username:password
Accept: */*

text

Retrieve a schedule

get

Returns the schedule for the generic Edge capability with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ingestibleIdstring · uuidRequired

Responses

200

Capability synchronization schedule

application/json

idinteger · int64Optional

cronExpressionstringOptional

cronTimeZonestringOptional

lastRunTimeStampinteger · int64Optional

nextRunDateLongValueinteger · int64Optional

cronJsonstringOptional

workflowstringOptional

get/genericIntegration/{ingestibleId}/schedule

GET /rest/catalog/1.0/genericIntegration/{ingestibleId}/schedule HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Capability synchronization schedule

{
  "id": 1,
  "cronExpression": "text",
  "cronTimeZone": "text",
  "lastRunTimeStamp": 1,
  "nextRunDateLongValue": 1,
  "cronJson": "text",
  "workflow": "text"
}

Add a schedule

post

Adds a schedule for the generic Edge capability with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ingestibleIdstring · uuidRequired

Query parameters

workflowstringOptional

Body

cronExpressionstringRequired

cronTimeZonestringRequired

cronJsonstringOptional

Responses

200

Cloud synchronization schedule added

application/json

idinteger · int64Optional

cronExpressionstringOptional

cronTimeZonestringOptional

lastRunTimeStampinteger · int64Optional

nextRunDateLongValueinteger · int64Optional

cronJsonstringOptional

workflowstringOptional

post/genericIntegration/{ingestibleId}/schedule

POST /rest/catalog/1.0/genericIntegration/{ingestibleId}/schedule HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "cronExpression": "text",
  "cronTimeZone": "text",
  "cronJson": "text"
}

200

Cloud synchronization schedule added

{
  "id": 1,
  "cronExpression": "text",
  "cronTimeZone": "text",
  "lastRunTimeStamp": 1,
  "nextRunDateLongValue": 1,
  "cronJson": "text",
  "workflow": "text"
}

Update a schedule

put

Updates the schedule for the generic Edge capability with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ingestibleIdstring · uuidRequired

Query parameters

workflowstringOptional

Body

cronExpressionstringRequired

cronTimeZonestringRequired

cronJsonstringOptional

Responses

200

Synchronization schedule updated

application/json

idinteger · int64Optional

cronExpressionstringOptional

cronTimeZonestringOptional

lastRunTimeStampinteger · int64Optional

nextRunDateLongValueinteger · int64Optional

cronJsonstringOptional

workflowstringOptional

201

New Synchronization schedule created

application/json

put/genericIntegration/{ingestibleId}/schedule

PUT /rest/catalog/1.0/genericIntegration/{ingestibleId}/schedule HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "cronExpression": "text",
  "cronTimeZone": "text",
  "cronJson": "text"
}

{
  "id": 1,
  "cronExpression": "text",
  "cronTimeZone": "text",
  "lastRunTimeStamp": 1,
  "nextRunDateLongValue": 1,
  "cronJson": "text",
  "workflow": "text"
}

Delete a schedule

delete

Deletes the schedule from the generic Edge capability with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ingestibleIdstring · uuidRequired

Query parameters

workflowstringOptional

Responses

204

Capability synchronization schedule deleted

No content

delete/genericIntegration/{ingestibleId}/schedule

DELETE /rest/catalog/1.0/genericIntegration/{ingestibleId}/schedule HTTP/1.1
Authorization: Basic username:password
Accept: */*

204

Capability synchronization schedule deleted

No content

Retrieve all schedules

get

Returns all schedules for the generic Edge capability with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ingestibleIdstring · uuidRequired

Responses

200

All capability synchronization schedules

application/json

idinteger · int64Optional

cronExpressionstringOptional

cronTimeZonestringOptional

lastRunTimeStampinteger · int64Optional

nextRunDateLongValueinteger · int64Optional

cronJsonstringOptional

workflowstringOptional

get/genericIntegration/{ingestibleId}/schedules

GET /rest/catalog/1.0/genericIntegration/{ingestibleId}/schedules HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

All capability synchronization schedules

{
  "id": 1,
  "cronExpression": "text",
  "cronTimeZone": "text",
  "lastRunTimeStamp": 1,
  "nextRunDateLongValue": 1,
  "cronJson": "text",
  "workflow": "text"
}

Cancel a synchronization

delete

Cancel the synchronization of the generic Edge capability with the specified ID.

Authorizations

AuthorizationstringRequired

Path parameters

ingestibleIdstring · uuidRequired

Query parameters

workflowstringOptional

Responses

404

No job to cancel

No content

delete/genericIntegration/{ingestibleId}/cancel

DELETE /rest/catalog/1.0/genericIntegration/{ingestibleId}/cancel HTTP/1.1
Authorization: Basic username:password
Accept: */*

404

No job to cancel

No content

Starts capability on Edge.

post

Starts an Edge based capability job

Authorizations

AuthorizationstringRequired

Path parameters

ingestibleIdstring · uuidRequired

Query parameters

cloudIngestionJobIdstring · uuidOptional

workflowstringOptional

Body

stringOptional

Responses

202

Cloud synchronization job successfully started

application/json

idstring · uuidOptional

createdBystring · uuidOptional

createdOninteger · int64Optional

lastModifiedBystring · uuidOptional

lastModifiedOninteger · int64Optional

systembooleanOptional

resourceTypestringOptional

namestringOptional

typestringOptional

userIdstring · uuidOptional

visibilityinteger · int32Optional

progressPercentagenumber · doubleOptional

cancelablebooleanOptional

startDateinteger · int64Optional

endDateinteger · int64Optional

statestringOptional

resultstringOptional

messagestringOptional

post/genericIntegration/{ingestibleId}/run

POST /rest/catalog/1.0/genericIntegration/{ingestibleId}/run HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

202

Cloud synchronization job successfully started

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": 1,
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedOn": 1,
  "system": true,
  "resourceType": "text",
  "name": "text",
  "type": "text",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": 1,
  "progressPercentage": 1,
  "cancelable": true,
  "startDate": 1,
  "endDate": 1,
  "state": "text",
  "result": "text",
  "message": "text"
}

PreviousS3 NextModels

Last updated 25 days ago

Was this helpful?