API Reference

Backend API documentation

Weik.io Admin API specification

Version: 2025.2

Action

GET /automation/action/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		ActionEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Content": "string",
  "Parameters": [
    "..."
  ],
  "DefaultParameterValues": [
    "..."
  ]
}

DELETE /automation/action/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

PUT /automation/action/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
newContent	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		ActionEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Content": "string",
  "Parameters": [
    "..."
  ],
  "DefaultParameterValues": [
    "..."
  ]
}

GET /automation/action/find

Parameters:

Name	Location	Type	Required	Description
name	query	`string`	Yes

Responses:

Status	Description	Type
200		ActionEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Content": "string",
  "Parameters": [
    "..."
  ],
  "DefaultParameterValues": [
    "..."
  ]
}

GET /automation/action

Responses:

Status	Description	Type
200		array<ActionEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "Content": "string",
    "Parameters": [
      "..."
    ],
    "DefaultParameterValues": [
      "..."
    ]
  }
]

POST /automation/action

Parameters:

Name	Location	Type	Required	Description
dto	body	NewActionDto	No

Request Body:

Type: NewActionDto
Required: No

Request Example:

{
  "Name": "string",
  "Content": "string"
}

Responses:

Status	Description	Type
200		ActionEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Content": "string",
  "Parameters": [
    "..."
  ],
  "DefaultParameterValues": [
    "..."
  ]
}

GET /automation/action/{id}/history

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<ActionExecutionEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "ActionId": "00000000-0000-0000-0000-000000000000",
    "ActionName": "string",
    "ReceivedParameters": [
      "..."
    ],
    "Parameters": [
      "..."
    ],
    "StatusCode": 0,
    "Duration": "string",
    "TriggerId": "00000000-0000-0000-0000-000000000000",
    "Error": "string",
    "Finished": false
  }
]

POST /automation/action/{id}/run

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
request	body	RunActionRequest	No

Request Body:

Type: RunActionRequest
Required: No

Request Example:

{
  "PreferredFormat": "string",
  "Parameters": [
    "..."
  ],
  "TriggerId": "00000000-0000-0000-0000-000000000000",
  "TriggerType": "string"
}

Responses:

Status	Description	Type
200		`file`

Admin

GET /api/EventHub/Admin/channels

Responses:

Status	Description	Type
200		array<ChannelEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "Type": "string",
    "AppId": "string",
    "Parameters": null,
    "JsonConfiguration": "string",
    "Components": [
      "..."
    ],
    "Endpoints": [
      "..."
    ]
  }
]

POST /api/EventHub/Admin/channels

Parameters:

Name	Location	Type	Required	Description
newChannel	body	NewChannelDto	No

Request Body:

Type: NewChannelDto
Required: No

Request Example:

{
  "Name": "string",
  "Type": "string",
  "Configuration": "string",
  "Components": [
    "..."
  ],
  "Endpoints": [
    "..."
  ],
  "AppId": "string"
}

Responses:

Status	Description	Type
201		ChannelDto

Response Example (201):

{
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Type": "string"
}

GET /api/EventHub/Admin/channels/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		ChannelEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Type": "string",
  "AppId": "string",
  "Parameters": null,
  "JsonConfiguration": "string",
  "Components": [
    "..."
  ],
  "Endpoints": [
    "..."
  ]
}

DELETE /api/EventHub/Admin/channels/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

GET /api/EventHub/Admin/subscriptions

Responses:

Status	Description	Type
200		array<SubscriptionEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "ChannelId": "00000000-0000-0000-0000-000000000000",
    "ChannelName": "string",
    "EventType": "string",
    "AppId": "string",
    "SpecVersion": "string",
    "Source": "string"
  }
]

POST /api/EventHub/Admin/subscriptions

Parameters:

Name	Location	Type	Required
channelId	query	`string (guid)`	Yes
source	query	`string`	Yes
eventType	query	`string`	Yes
specVersion	query	`string`	Yes

Responses:

Status	Description	Type
201		SubscriptionEntity

Response Example (201):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "ChannelName": "string",
  "EventType": "string",
  "AppId": "string",
  "SpecVersion": "string",
  "Source": "string"
}

DELETE /api/EventHub/Admin/subscriptions

Parameters:

Name	Location	Type	Required	Description
subscriptionId	query	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

GET /api/EventHub/Admin/subscriptions/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		SubscriptionEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "ChannelName": "string",
  "EventType": "string",
  "AppId": "string",
  "SpecVersion": "string",
  "Source": "string"
}

GET /api/EventHub/Admin/eventDefinitions

Responses:

Status	Description	Type
200		array<CloudEventDefinitionEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Definition": "...",
    "Type": "string",
    "Source": "string",
    "SpecVersion": "string",
    "DataContentType": "string",
    "DataSchemaUri": "string",
    "DataSchema": "string",
    "Tags": [
      "..."
    ]
  }
]

GET /api/EventHub/Admin/eventDefinitions/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		CloudEventDefinitionEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Definition": {
    "Type": "...",
    "Source": "...",
    "SpecVersion": "...",
    "DataContentType": "...",
    "DataSchemaUri": "...",
    "DataSchema": "...",
    "Tags": "..."
  },
  "Type": "string",
  "Source": "string",
  "SpecVersion": "string",
  "DataContentType": "string",
  "DataSchemaUri": "string",
  "DataSchema": "string",
  "Tags": [
    "string"
  ]
}

GET /api/EventHub/Admin/eventDefinitions/{eventDefinitionId}/channels

Parameters:

Name	Location	Type	Required	Description
eventDefinitionId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<ChannelDto>

Response Example (200):

[
  {
    "ChannelId": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "Type": "string"
  }
]

GET /api/EventHub/Admin/channels/{channelId}/eventDefinitions

Parameters:

Name	Location	Type	Required	Description
channelId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<CloudEventDefinitionEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Definition": "...",
    "Type": "string",
    "Source": "string",
    "SpecVersion": "string",
    "DataContentType": "string",
    "DataSchemaUri": "string",
    "DataSchema": "string",
    "Tags": [
      "..."
    ]
  }
]

POST /api/EventHub/Admin/channels/{id}/publish

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
data	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		`file`

Agent

POST /agent/register

Parameters:

Name	Location	Type	Required	Description
registrationData	body	AgentRegistrationData	No

Request Body:

Type: AgentRegistrationData
Required: No

Request Example:

{
  "Name": "string",
  "Token": "string",
  "InitialCapabities": [
    "..."
  ],
  "InitialBaseAddress": "string"
}

Responses:

Status	Description	Type
200		AgentRegistrationDto

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "ValidationToken": "string",
  "IdentityBaseAddress": "string",
  "ConfigurationBaseAddress": "string",
  "ServerBaseAddress": "string"
}

POST /agent/create

Parameters:

Name	Location	Type	Required	Description
key	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		PendingAgentRegistrationDto

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ServerBaseaddress": "string",
  "Token": "string"
}

POST /agent/register/validate

Parameters:

Name	Location	Type	Required	Description
validationDto	body	AgentValidationDto	No

Request Body:

Type: AgentValidationDto
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "RemoteAddress": "string",
  "ValidationToken": "string"
}

Responses:

Status	Description	Type
200		`boolean`

GET /agent/configuration

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

GET /agent/{id}/endpoints/{endpointId}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
endpointId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		IntegrationEndpointAgent
204		`void`

Response Example (200):

{
  "EndpointId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Route": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "Configuration": "string",
  "EndpointStatus": 0
}

GET /agent/endpoints

Parameters:

Name	Location	Type	Required	Description
agentId	query	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<IntegrationEndpointAgent>

Response Example (200):

[
  {
    "EndpointId": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "Route": "string",
    "ApiName": "string",
    "ApiVersion": "string",
    "Configuration": "string",
    "EndpointStatus": "..."
  }
]

GET /agent/api/packages

Responses:

Status	Description	Type
200		array<IntegrationApiPackageAgent>

Response Example (200):

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "PackageName": "string",
    "PackageVersion": "string"
  }
]

GET /agent/eventing/catalog

Responses:

Status	Description	Type
200		array<EventingEventSourceCatalogAgent>

Response Example (200):

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "CatalogName": "string",
    "CatalogVersion": "string"
  }
]

GET /agent/{id}/eventing/{eventSourceInstanceId}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
eventSourceInstanceId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		EventingEventSourceInstanceAgent

Response Example (200):

{
  "EventSourceInstanceId": "00000000-0000-0000-0000-000000000000",
  "EventSourceId": "string",
  "Name": "string",
  "EventSourceType": "string",
  "EventSourceVersion": "string",
  "Configuration": "string",
  "PollingFrequency": "string",
  "CronExpression": "string"
}

GET /agent/eventing/eventSourceInstances

Parameters:

Name	Location	Type	Required	Description
agentId	query	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<EventingEventSourceInstanceAgent>

Response Example (200):

[
  {
    "EventSourceInstanceId": "00000000-0000-0000-0000-000000000000",
    "EventSourceId": "string",
    "Name": "string",
    "EventSourceType": "string",
    "EventSourceVersion": "string",
    "Configuration": "string",
    "PollingFrequency": "string",
    "CronExpression": "string"
  }
]

AgentEndpointSchema

GET /agents/integrations/schemas/{endpointId}

Parameters:

Name	Location	Type	Required	Description
endpointId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<AgentEndpointSchema>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "AgentId": "00000000-0000-0000-0000-000000000000",
    "EndpointId": "00000000-0000-0000-0000-000000000000",
    "Schema": "string"
  }
]

GET /agents/integrations/schemas/generate

Parameters:

Name	Location	Type	Required	Description
endpointName	query	`string`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

AgentEndpoints

GET /agent/endpoint/{endpointId}/statusUpdates

Parameters:

Name	Location	Type	Required	Description
endpointId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<AgentEndpointStatus>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "AgentId": "00000000-0000-0000-0000-000000000000",
    "EndpointId": "00000000-0000-0000-0000-000000000000",
    "Route": "string",
    "Configuration": "string",
    "CurrentStatus": "...",
    "PreviousStatus": "...",
    "LastStatusUpdate": "2024-01-01T00:00:00Z",
    "StatusUpdates": [
      "..."
    ]
  }
]

GET /agent/endpoint/{endpointId}/agents/currentStatus

Parameters:

Name	Location	Type	Required	Description
endpointId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<AgentEndpointStatus>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "AgentId": "00000000-0000-0000-0000-000000000000",
    "EndpointId": "00000000-0000-0000-0000-000000000000",
    "Route": "string",
    "Configuration": "string",
    "CurrentStatus": "...",
    "PreviousStatus": "...",
    "LastStatusUpdate": "2024-01-01T00:00:00Z",
    "StatusUpdates": [
      "..."
    ]
  }
]

GET /agent/endpoint/{agentId}

Parameters:

Name	Location	Type	Required	Description
agentId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<IntegrationEndpointAgent>

Response Example (200):

[
  {
    "EndpointId": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "Route": "string",
    "ApiName": "string",
    "ApiVersion": "string",
    "Configuration": "string",
    "EndpointStatus": "..."
  }
]

GET /agent/endpoint/{endpointId}/agent/{agentId}

Parameters:

Name	Location	Type	Required	Description
agentId	path	`string (guid)`	Yes
endpointId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		IntegrationEndpointAgent

Response Example (200):

{
  "EndpointId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Route": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "Configuration": "string",
  "EndpointStatus": 0
}

AgentManagement

GET /agents

Parameters:

Name	Location	Type	Required	Description
Status	query	array<AgentStatusEnum>	No

Responses:

Status	Description	Type
200		array<Agent>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "PoolName": "string",
    "Capabilities": [
      "..."
    ],
    "CurrentStatusEnum": "...",
    "CurrentStatusMessage": "string",
    "IntegrationStatus": "...",
    "LastSeen": "2024-01-01T00:00:00Z",
    "BaseAddress": "string",
    "LastBuildVersion": "string",
    "LastBuildDate": "2024-01-01T00:00:00Z",
    "LastUpdateDate": "2024-01-01T00:00:00Z"
  }
]

PUT /agents

Parameters:

Name	Location	Type	Required	Description
agent	body	Agent	No

Request Body:

Type: Agent
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "PoolName": "string",
  "Capabilities": [
    "..."
  ],
  "CurrentStatusEnum": 0,
  "CurrentStatusMessage": "string",
  "IntegrationStatus": 0,
  "LastSeen": "2024-01-01T00:00:00Z",
  "BaseAddress": "string",
  "LastBuildVersion": "string",
  "LastBuildDate": "2024-01-01T00:00:00Z",
  "LastUpdateDate": "2024-01-01T00:00:00Z"
}

Responses:

Status	Description	Type
200		Agent

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "PoolName": "string",
  "Capabilities": [
    "..."
  ],
  "CurrentStatusEnum": 0,
  "CurrentStatusMessage": "string",
  "IntegrationStatus": 0,
  "LastSeen": "2024-01-01T00:00:00Z",
  "BaseAddress": "string",
  "LastBuildVersion": "string",
  "LastBuildDate": "2024-01-01T00:00:00Z",
  "LastUpdateDate": "2024-01-01T00:00:00Z"
}

GET /agents/{agentId}

Parameters:

Name	Location	Type	Required	Description
agentId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		Agent

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "PoolName": "string",
  "Capabilities": [
    "..."
  ],
  "CurrentStatusEnum": 0,
  "CurrentStatusMessage": "string",
  "IntegrationStatus": 0,
  "LastSeen": "2024-01-01T00:00:00Z",
  "BaseAddress": "string",
  "LastBuildVersion": "string",
  "LastBuildDate": "2024-01-01T00:00:00Z",
  "LastUpdateDate": "2024-01-01T00:00:00Z"
}

GET /agents/{agentId}/history

Parameters:

Name	Location	Type	Required	Description
agentId	path	`string (guid)`	Yes
limit	query	`integer (int32)`	Yes

Responses:

Status	Description	Type
200		array<AgentStatusHistoryItem>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "AgentId": "00000000-0000-0000-0000-000000000000",
    "StatusUpdate": "..."
  }
]

GET /agents/{agentId}/history/{id}

Parameters:

Name	Location	Type	Required	Description
agentId	path	`string (guid)`	Yes
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		AgentStatusHistoryItem

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "AgentId": "00000000-0000-0000-0000-000000000000",
  "StatusUpdate": {
    "AgentId": "...",
    "Endpoints": "...",
    "SystemStatus": "...",
    "AvailableApis": "...",
    "Capabilities": "...",
    "BuildVersion": "...",
    "BuildDate": "...",
    "AgentName": "...",
    "PoolName": "...",
    "BaseAddress": "...",
    "IntegrationFlowStatusList": "..."
  }
}

GET /agents/pending

Responses:

Status	Description	Type
200		array<PendingAgentRegistration>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "PoolName": "string",
    "Expires": "2024-01-01T00:00:00Z"
  }
]

POST /agents/create

Parameters:

Name	Location	Type	Required	Description
poolName	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		PendingAgentRegistrationDto

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ServerBaseaddress": "string",
  "Token": "string"
}

DELETE /agents/pending/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

POST /agents/{id}/deprecate

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		Agent

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "PoolName": "string",
  "Capabilities": [
    "..."
  ],
  "CurrentStatusEnum": 0,
  "CurrentStatusMessage": "string",
  "IntegrationStatus": 0,
  "LastSeen": "2024-01-01T00:00:00Z",
  "BaseAddress": "string",
  "LastBuildVersion": "string",
  "LastBuildDate": "2024-01-01T00:00:00Z",
  "LastUpdateDate": "2024-01-01T00:00:00Z"
}

PUT /agents/{agentId}/status

Parameters:

Name	Location	Type	Required	Description
agentId	path	`string (guid)`	Yes
statusEnum	query	`integer`	Yes

Responses:

Status	Description	Type
200		Agent

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "PoolName": "string",
  "Capabilities": [
    "..."
  ],
  "CurrentStatusEnum": 0,
  "CurrentStatusMessage": "string",
  "IntegrationStatus": 0,
  "LastSeen": "2024-01-01T00:00:00Z",
  "BaseAddress": "string",
  "LastBuildVersion": "string",
  "LastBuildDate": "2024-01-01T00:00:00Z",
  "LastUpdateDate": "2024-01-01T00:00:00Z"
}

Api

GET /integrations/api/{name}/{version}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes
version	path	`string`	Yes

Responses:

Status	Description	Type
200		IntegrationApi

Response Example (200):

{
  "ApiPackageId": "00000000-0000-0000-0000-000000000000",
  "PackageName": "string",
  "PackageVersion": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "ConfigurationSchema": "string",
  "Description": "string",
  "ProductVersion": "string",
  "Identifier": "string"
}

GET /integrations/api/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string`	Yes

Responses:

Status	Description	Type
200		IntegrationApi

Response Example (200):

{
  "ApiPackageId": "00000000-0000-0000-0000-000000000000",
  "PackageName": "string",
  "PackageVersion": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "ConfigurationSchema": "string",
  "Description": "string",
  "ProductVersion": "string",
  "Identifier": "string"
}

GET /integrations/api

Responses:

Status	Description	Type
200		array<IntegrationApi>

Response Example (200):

[
  {
    "ApiPackageId": "00000000-0000-0000-0000-000000000000",
    "PackageName": "string",
    "PackageVersion": "string",
    "ApiName": "string",
    "ApiVersion": "string",
    "ConfigurationSchema": "string",
    "Description": "string",
    "ProductVersion": "string",
    "Identifier": "string"
  }
]

GET /apim/apis

Responses:

Status	Description	Type
200		array<ApiDetailsDto>

Response Example (200):

[
  {
    "Versions": [
      "..."
    ],
    "Subscriptions": [
      "..."
    ],
    "Name": "string",
    "Description": "string",
    "Prefix": "string"
  }
]

GET /apim/apis/{apiName}

Parameters:

Name	Location	Type	Required	Description
apiName	path	`string`	Yes

Responses:

Status	Description	Type
200		ApiDetailsDto

Response Example (200):

{
  "Versions": [
    "..."
  ],
  "Subscriptions": [
    "..."
  ],
  "Name": "string",
  "Description": "string",
  "Prefix": "string"
}

GET /apim/apis/versions

Parameters:

Name	Location	Type	Required	Description
apiName	query	`string`	Yes

Responses:

Status	Description	Type
200		array<ApiVersion>

Response Example (200):

[
  {
    "Version": "string",
    "ApiName": "string",
    "Description": "string",
    "IsActive": false,
    "Type": "string",
    "Parameters": null,
    "Variables": null,
    "Authentication": "...",
    "Connection": "...",
    "Key": "string"
  }
]

ApiKey

GET /identity/apikey/{username}

Parameters:

Name	Location	Type	Required	Description
username	path	`string`	Yes

Responses:

Status	Description	Type
200		`array<string>`

Response Example (200):

[
  "string"
]

POST /identity/apikey

Parameters:

Name	Location	Type	Required
username	query	`string`	Yes
name	query	`string`	No
description	query	`string`	No

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

DELETE /{username}/{keyname}

Parameters:

Name	Location	Type	Required	Description
username	path	`string`	Yes
keyname	path	`string`	Yes

Responses:

Status	Description	Type
200		`file`

ApiPackage

POST /integrations/packages

Parameters:

Name	Location	Type	Required	Description
api	body	IntegrationApiPackage	No

Request Body:

Type: IntegrationApiPackage
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "PackageName": "string",
  "PackageVersion": "string",
  "Apis": [
    "..."
  ],
  "Status": 0
}

Responses:

Status	Description	Type
200		IntegrationApiPackage

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "PackageName": "string",
  "PackageVersion": "string",
  "Apis": [
    "..."
  ],
  "Status": 0
}

GET /integrations/packages

Responses:

Status	Description	Type
200		array<IntegrationApiPackage>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "PackageName": "string",
    "PackageVersion": "string",
    "Apis": [
      "..."
    ],
    "Status": "..."
  }
]

DELETE /integrations/packages/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

GET /integrations/packages/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		IntegrationApiPackage

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "PackageName": "string",
  "PackageVersion": "string",
  "Apis": [
    "..."
  ],
  "Status": 0
}

ApiVersion

GET /apim/apiversions

Responses:

Status	Description	Type
200		array<ApiVersion>

Response Example (200):

[
  {
    "Version": "string",
    "ApiName": "string",
    "Description": "string",
    "IsActive": false,
    "Type": "string",
    "Parameters": null,
    "Variables": null,
    "Authentication": "...",
    "Connection": "...",
    "Key": "string"
  }
]

ApimSubscriptions

GET /apim/subscriptions

Responses:

Status	Description	Type
200		array<ApiSubscriptionDto>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string",
    "Apis": [
      "..."
    ],
    "Type": "string",
    "Parameters": "string",
    "Key": "string"
  }
]

Catalog

GET /api/EventHub/Catalog

Responses:

Status	Description	Type
200		array<TriggerType>

Response Example (200):

[
  {
    "Name": "string",
    "Version": "...",
    "Description": "string",
    "Configuration": "..."
  }
]

Channels

GET /api/EventHub/Channels

Responses:

Status	Description	Type
200		array<ChannelDto>

Response Example (200):

[
  {
    "ChannelId": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "Type": "string"
  }
]

POST /api/EventHub/Channels

Parameters:

Name	Location	Type	Required	Description
newChannel	body	NewChannelDto	No

Request Body:

Type: NewChannelDto
Required: No

Request Example:

{
  "Name": "string",
  "Type": "string",
  "Configuration": "string",
  "Components": [
    "..."
  ],
  "Endpoints": [
    "..."
  ],
  "AppId": "string"
}

Responses:

Status	Description	Type
201		ChannelDto

Response Example (201):

{
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Type": "string"
}

DELETE /api/EventHub/Channels

Parameters:

Name	Location	Type	Required	Description
channelName	query	`string`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

POST /api/EventHub/Channels/http

Parameters:

Name	Location	Type	Required	Description
channelDto	body	HttpChannelDto	No

Request Body:

Type: HttpChannelDto
Required: No

Request Example:

{
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Type": "string",
  "Endpoint": "string",
  "BasicAuthUsername": "string",
  "BasicAuthPassword": "string"
}

Responses:

Status	Description	Type
201		ChannelDto

Response Example (201):

{
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Type": "string"
}

POST /api/EventHub/Channels/azureservicebus

Parameters:

Name	Location	Type	Required	Description
channelDto	body	AzureServiceBusDto	No

Request Body:

Type: AzureServiceBusDto
Required: No

Request Example:

{
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Type": "string",
  "Queuename": "string",
  "ConnectionString": "string"
}

Responses:

Status	Description	Type
201		ChannelDto

Response Example (201):

{
  "ChannelId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Type": "string"
}

Component

GET /eventing/component

Responses:

Status	Description	Type
200		array<EventingComponent>

Response Example (200):

[
  {
    "ComponentCatalogId": "00000000-0000-0000-0000-000000000000",
    "CatalogName": "string",
    "CatalogVersion": "string",
    "Name": "string",
    "Version": "string",
    "ConfigurationSchema": "string",
    "Description": "string",
    "ProductVersion": "string",
    "Identifier": "string"
  }
]

GET /eventing/component/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string`	Yes

Responses:

Status	Description	Type
200		EventingComponent

Response Example (200):

{
  "ComponentCatalogId": "00000000-0000-0000-0000-000000000000",
  "CatalogName": "string",
  "CatalogVersion": "string",
  "Name": "string",
  "Version": "string",
  "ConfigurationSchema": "string",
  "Description": "string",
  "ProductVersion": "string",
  "Identifier": "string"
}

ComponentCatalog

POST /eventing/componentCatalog

Parameters:

Name	Location	Type	Required	Description
catalog	body	EventingComponentCatalog	No

Request Body:

Type: EventingComponentCatalog
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CatalogName": "string",
  "CatalogVersion": "string",
  "Components": [
    "..."
  ],
  "Status": 0
}

Responses:

Status	Description	Type
200		EventingComponentCatalog

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CatalogName": "string",
  "CatalogVersion": "string",
  "Components": [
    "..."
  ],
  "Status": 0
}

GET /eventing/componentCatalog

Responses:

Status	Description	Type
200		array<EventingComponentCatalog>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "CatalogName": "string",
    "CatalogVersion": "string",
    "Components": [
      "..."
    ],
    "Status": "..."
  }
]

DELETE /eventing/componentCatalog/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

GET /eventing/componentCatalog/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		EventingComponentCatalog

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CatalogName": "string",
  "CatalogVersion": "string",
  "Components": [
    "..."
  ],
  "Status": 0
}

Configuration

PUT /configuration

Parameters:

Name	Location	Type	Required	Description
configuration	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
202		`void`

CoreSystem

GET /integrations/coresystems

Responses:

Status	Description	Type
200		array<CoreSystem2>

Response Example (200):

[
  {
    "Name": "string",
    "Title": "string",
    "Description": "string",
    "Category": "string",
    "Type": "string",
    "Variables": null
  }
]

PUT /integrations/coresystems

Parameters:

Name	Location	Type	Required	Description
newSystem	body	CoreSystem2	No

Request Body:

Type: CoreSystem2
Required: No

Request Example:

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Type": "string",
  "Variables": null
}

Responses:

Status	Description	Type
200		CoreSystem2

Response Example (200):

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Type": "string",
  "Variables": null
}

DELETE /integrations/coresystems

Parameters:

Name	Location	Type	Required	Description
systemName	query	`string`	Yes

Responses:

Status	Description	Type
200		`file`

GET /integrations/coresystems/{core}

Parameters:

Name	Location	Type	Required	Description
core	path	`string`	Yes

Responses:

Status	Description	Type
200		CoreSystemDto

Response Example (200):

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Type": "string",
  "Variables": "string"
}

GET /integrations/coresystems/storages

Responses:

Status	Description	Type
200		array<StorageDto>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string"
  }
]

GET /integrations/coresystems/core

Responses:

Status	Description	Type
200		array<CoreDto>

Response Example (200):

[
  {
    "Name": "string",
    "Title": "string",
    "Description": "string",
    "Label": "string"
  }
]

DatabaseChangeTracking

GET /databasechangetracking/configurations

Responses:

Status	Description	Type
200		array<DatabaseChangeTrackingDto>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string",
    "Type": "string",
    "Parameters": null,
    "Variables": null,
    "CreatedAt": "2024-01-01T00:00:00Z"
  }
]

GET /databasechangetracking/configurations/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		DatabaseChangeTrackingDto

Response Example (200):

{
  "Name": "string",
  "Description": "string",
  "Type": "string",
  "Parameters": null,
  "Variables": null,
  "CreatedAt": "2024-01-01T00:00:00Z"
}

EndpointSchema

GET /schema/endpoint/schema/{endpointId}

Parameters:

Name	Location	Type	Required	Description
endpointId	path	`string (guid)`	Yes
externalHostName	query	`boolean`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

GET /schema/endpoint/schema/{endpointId}/download

Parameters:

Name	Location	Type	Required	Description
endpointId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

Engine

POST /interactive/engine/run

Parameters:

Name	Location	Type	Required	Description
request	body	ExecuteRequest	No

Request Body:

Type: ExecuteRequest
Required: No

Request Example:

{
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "Code": "string",
  "CommandPrefix": "string",
  "FreshKernel": false,
  "PreferredFormat": "string",
  "KernelType": "string"
}

Responses:

Status	Description	Type
200		array<ExecuteResult>

Response Example (200):

[
  {
    "Id": "string",
    "Output": null,
    "OutputType": "string",
    "OutputJson": "string",
    "OutputString": "string",
    "DisplayString": "string",
    "FormattedResults": [
      "..."
    ],
    "Duration": "string",
    "Time": "2024-01-01T00:00:00Z"
  }
]

POST /interactive/engine/suggestions

Parameters:

Name	Location	Type	Required	Description
suggestionsRequest	body	GetSuggestionsRequest	No

Request Body:

Type: GetSuggestionsRequest
Required: No

Request Example:

{
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "Code": "string",
  "LineNumber": 0,
  "Column": 0
}

Responses:

Status	Description	Type
200		array<Suggestion>

Response Example (200):

[
  {
    "Label": "string",
    "InsertText": "string",
    "Kind": "...",
    "Documentation": "string"
  }
]

GET /interactive/engine/file

Parameters:

Name	Location	Type	Required	Description
id	query	`string`	Yes

Responses:

Status	Description	Type
200		`file`

POST /interactive/engine/execute

Parameters:

Name	Location	Type	Required	Description
dibRequest	body	ExecuteDibRequest	No

Request Body:

Type: ExecuteDibRequest
Required: No

Request Example:

{
  "Dib": "string",
  "SessionId": "string",
  "Parameters": [
    "..."
  ],
  "PreferredFormat": "string",
  "KernelType": "string",
  "OneTimeKernel": false
}

Responses:

Status	Description	Type
200		`file`

EntityEventStore

GET /events/store/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		EntityEventItem

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "EventType": "string",
  "EntityId": "string",
  "EntityType": "string",
  "Content": "string",
  "Subject": "string",
  "Source": "string"
}

GET /events/store

Parameters:

Name	Location	Type	Required
entityId	query	`string`	Yes
fromDate	query	`string (date-time)`	Yes
toDate	query	`string (date-time)`	Yes

Responses:

Status	Description	Type
200		array<EntityEventItem>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "EventType": "string",
    "EntityId": "string",
    "EntityType": "string",
    "Content": "string",
    "Subject": "string",
    "Source": "string"
  }
]

EntityStore

GET /integrations/entitystore

Parameters:

Name	Location	Type	Required	Description
entityType	query	`string`	Yes
entityId	query	`string`	Yes

Responses:

Status	Description	Type
200		KeyValuePairOfStringAndString

Response Example (200):

{
  "Key": "string",
  "Value": "string"
}

GET /integrations/entitystore/search

Parameters:

Name	Location	Type	Required
entityType	query	`string`	Yes
entityId	query	`string`	Yes
limit	query	`integer (int32)`	Yes
fromDate	query	`string (date-time)`	Yes
includeHistory	query	`boolean`	Yes

Responses:

Status	Description	Type
200		EntityStoreSearchResults

Response Example (200):

{
  "Data": [
    "..."
  ],
  "LimitReached": false
}

GET /integrations/entitystore/info

Responses:

Status	Description	Type
200		EntityStoreInfo

Response Example (200):

{
  "EntitiesStored": 0,
  "EntitiesStoredIncludingHistory": 0,
  "HistoryKept": 0,
  "Size": 0,
  "MaxSize": 0,
  "MaximumAge": "string"
}

EventChannelV2

GET /eventchannels/v2

Responses:

Status	Description	Type
200		array<EventChannelDtov2>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string",
    "Type": "string",
    "Parameters": null,
    "Variables": null,
    "Requirements": null,
    "CreatedAt": "2024-01-01T00:00:00Z"
  }
]

GET /eventchannels/v2/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		EventChannelDtov2

Response Example (200):

{
  "Name": "string",
  "Description": "string",
  "Type": "string",
  "Parameters": null,
  "Variables": null,
  "Requirements": null,
  "CreatedAt": "2024-01-01T00:00:00Z"
}

EventDefinitions

GET /api/EventHub/EventDefinitions

Responses:

Status	Description	Type
200		array<CloudEventDefinition>

Response Example (200):

[
  {
    "Type": "string",
    "Source": "string",
    "SpecVersion": "string",
    "DataContentType": "string",
    "DataSchemaUri": "string",
    "DataSchema": "string",
    "Tags": [
      "..."
    ]
  }
]

POST /api/EventHub/EventDefinitions

Parameters:

Name	Location	Type	Required	Description
definition	body	CloudEventDefinition	No

Request Body:

Type: CloudEventDefinition
Required: No

Request Example:

{
  "Type": "string",
  "Source": "string",
  "SpecVersion": "string",
  "DataContentType": "string",
  "DataSchemaUri": "string",
  "DataSchema": "string",
  "Tags": [
    "string"
  ]
}

Responses:

Status	Description	Type
200		CloudEventDefinition

Response Example (200):

{
  "Type": "string",
  "Source": "string",
  "SpecVersion": "string",
  "DataContentType": "string",
  "DataSchemaUri": "string",
  "DataSchema": "string",
  "Tags": [
    "string"
  ]
}

DELETE /api/EventHub/EventDefinitions/{eventType}/{eventSource}/{eventSpec}

Parameters:

Name	Location	Type	Required
eventType	path	`string`	Yes
eventSource	path	`string`	Yes
eventSpec	path	`string`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

EventSource

GET /eventing/sources

Responses:

Status	Description	Type
200		array<EventingEventSource>

Response Example (200):

[
  {
    "EventSourceCatalogId": "00000000-0000-0000-0000-000000000000",
    "CatalogName": "string",
    "CatalogVersion": "string",
    "Name": "string",
    "Version": "string",
    "ConfigurationSchema": "string",
    "Description": "string",
    "ProductVersion": "string",
    "RequiresPolling": false,
    "Identifier": "string"
  }
]

GET /eventing/sources/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string`	Yes

Responses:

Status	Description	Type
200		EventingEventSource

Response Example (200):

{
  "EventSourceCatalogId": "00000000-0000-0000-0000-000000000000",
  "CatalogName": "string",
  "CatalogVersion": "string",
  "Name": "string",
  "Version": "string",
  "ConfigurationSchema": "string",
  "Description": "string",
  "ProductVersion": "string",
  "RequiresPolling": false,
  "Identifier": "string"
}

EventSourceCatalog

POST /eventing/sourceCatalog

Parameters:

Name	Location	Type	Required	Description
catalog	body	EventingEventSourceCatalog	No

Request Body:

Type: EventingEventSourceCatalog
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CatalogName": "string",
  "CatalogVersion": "string",
  "EventSources": [
    "..."
  ],
  "Status": 0
}

Responses:

Status	Description	Type
200		EventingEventSourceCatalog

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CatalogName": "string",
  "CatalogVersion": "string",
  "EventSources": [
    "..."
  ],
  "Status": 0
}

GET /eventing/sourceCatalog

Responses:

Status	Description	Type
200		array<EventingEventSourceCatalog>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "CatalogName": "string",
    "CatalogVersion": "string",
    "EventSources": [
      "..."
    ],
    "Status": "..."
  }
]

DELETE /eventing/sourceCatalog/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

GET /eventing/sourceCatalog/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		EventingEventSourceCatalog

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CatalogName": "string",
  "CatalogVersion": "string",
  "EventSources": [
    "..."
  ],
  "Status": 0
}

EventSourceV2

GET /eventsources/v2

Responses:

Status	Description	Type
200		array<EventSourceDtov2>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string",
    "Type": "string",
    "Parameters": null,
    "Variables": null,
    "Requirements": null,
    "CreatedAt": "2024-01-01T00:00:00Z"
  }
]

GET /eventsources/v2/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		EventSourceDtov2

Response Example (200):

{
  "Name": "string",
  "Description": "string",
  "Type": "string",
  "Parameters": null,
  "Variables": null,
  "Requirements": null,
  "CreatedAt": "2024-01-01T00:00:00Z"
}

EventSubscriptionV2

GET /eventsubscriptions/v2

Responses:

Status	Description	Type
200		array<EventSubscriptionDtov2>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string",
    "Source": "string",
    "Channel": "string",
    "CreatedAt": "2024-01-01T00:00:00Z"
  }
]

GET /eventsubscriptions/v2/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		EventSubscriptionDtov2

Response Example (200):

{
  "Name": "string",
  "Description": "string",
  "Source": "string",
  "Channel": "string",
  "CreatedAt": "2024-01-01T00:00:00Z"
}

EventTrigger

GET /automation/triggers/event/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		EventTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "EventType": "string",
  "EventSource": "string",
  "Version": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

DELETE /automation/triggers/event/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

PUT /automation/triggers/event/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
updatedTrigger	body	EventTrigger	No

Request Body:

Type: EventTrigger
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "EventType": "string",
  "EventSource": "string",
  "Version": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

Responses:

Status	Description	Type
200		EventTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "EventType": "string",
  "EventSource": "string",
  "Version": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

GET /automation/triggers/event

Responses:

Status	Description	Type
200		array<EventTrigger>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "EventType": "string",
    "EventSource": "string",
    "Version": "string",
    "ActionId": "00000000-0000-0000-0000-000000000000",
    "ActionName": "string",
    "Parameters": [
      "..."
    ],
    "TriggerType": "string",
    "IsEnabled": false,
    "Name": "string"
  }
]

POST /automation/triggers/event

Parameters:

Name	Location	Type	Required	Description
newTrigger	body	EventTrigger	No

Request Body:

Type: EventTrigger
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "EventType": "string",
  "EventSource": "string",
  "Version": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

Responses:

Status	Description	Type
200		EventTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "EventType": "string",
  "EventSource": "string",
  "Version": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

GET /automation/triggers/event/find

Parameters:

Name	Location	Type	Required	Description
actionId	query	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<EventTrigger>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "EventType": "string",
    "EventSource": "string",
    "Version": "string",
    "ActionId": "00000000-0000-0000-0000-000000000000",
    "ActionName": "string",
    "Parameters": [
      "..."
    ],
    "TriggerType": "string",
    "IsEnabled": false,
    "Name": "string"
  }
]

PUT /automation/triggers/event/{id}/enabled

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		EventTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "EventType": "string",
  "EventSource": "string",
  "Version": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

EventingEventSourceInstance

GET /eventing/instances/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		EventingEventSourceInstance

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "EventSourceType": "string",
  "EventSourceVersion": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "PollingFrequency": "string",
  "CronExpression": "string",
  "Requirements": [
    "..."
  ]
}

DELETE /eventing/instances/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`void`

GET /eventing/instances

Responses:

Status	Description	Type
200		array<EventingEventSourceInstance>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "EventSourceType": "string",
    "EventSourceVersion": "string",
    "JsonConfiguration": "string",
    "Description": "string",
    "PollingFrequency": "string",
    "CronExpression": "string",
    "Requirements": [
      "..."
    ]
  }
]

POST /eventing/instances

Parameters:

Name	Location	Type	Required	Description
endpoint	body	EventingEventSourceInstance	No

Request Body:

Type: EventingEventSourceInstance
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "EventSourceType": "string",
  "EventSourceVersion": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "PollingFrequency": "string",
  "CronExpression": "string",
  "Requirements": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		EventingEventSourceInstance

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "EventSourceType": "string",
  "EventSourceVersion": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "PollingFrequency": "string",
  "CronExpression": "string",
  "Requirements": [
    "..."
  ]
}

PUT /eventing/instances

Parameters:

Name	Location	Type	Required	Description
instance	body	EventingEventSourceInstance	No

Request Body:

Type: EventingEventSourceInstance
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "EventSourceType": "string",
  "EventSourceVersion": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "PollingFrequency": "string",
  "CronExpression": "string",
  "Requirements": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		EventingEventSourceInstance

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "EventSourceType": "string",
  "EventSourceVersion": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "PollingFrequency": "string",
  "CronExpression": "string",
  "Requirements": [
    "..."
  ]
}

Events

GET /eventing/events

Parameters:

Name	Location	Type	Required
FromDate	query	`string (date-time)`	No
ToDate	query	`string (date-time)`	No
EventType	query	`string`	No
Channel	query	`string`	No
Limit	query	`integer (int32)`	No

Responses:

Status	Description	Type
200		array<EventOverviewDto>

Response Example (200):

[
  {
    "UtcDateTime": "2024-01-01T00:00:00Z",
    "EventType": "string",
    "Source": "string",
    "Id": "string"
  }
]

GET /eventing/events/channel

Parameters:

Name	Location	Type	Required	Description
channelName	query	`string`	Yes

Responses:

Status	Description	Type
200		array<EventOverviewDto>

Response Example (200):

[
  {
    "UtcDateTime": "2024-01-01T00:00:00Z",
    "EventType": "string",
    "Source": "string",
    "Id": "string"
  }
]

GET /eventing/events/eventtype

Parameters:

Name	Location	Type	Required	Description
eventType	query	`string`	Yes

Responses:

Status	Description	Type
200		array<EventOverviewDto>

Response Example (200):

[
  {
    "UtcDateTime": "2024-01-01T00:00:00Z",
    "EventType": "string",
    "Source": "string",
    "Id": "string"
  }
]

GET /eventing/events/eventdefinition/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<EventOverviewDto>

Response Example (200):

[
  {
    "UtcDateTime": "2024-01-01T00:00:00Z",
    "EventType": "string",
    "Source": "string",
    "Id": "string"
  }
]

GET /eventing/events/details

Parameters:

Name	Location	Type	Required	Description
eventId	query	`string`	Yes

Responses:

Status	Description	Type
200		EventDetailsDto

Response Example (200):

{
  "UtcDateTime": "2024-01-01T00:00:00Z",
  "EventType": "string",
  "Source": "string",
  "Id": "string",
  "Version": "string",
  "Json": "string",
  "TargetChannels": [
    "string"
  ]
}

IntegrationEndpointCrud

GET /integrations/endpoint/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		IntegrationEndpoint

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "Route": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "Requirements": [
    "..."
  ]
}

DELETE /integrations/endpoint/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`void`

GET /integrations/endpoint

Responses:

Status	Description	Type
200		array<IntegrationEndpoint>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "ApiName": "string",
    "ApiVersion": "string",
    "Route": "string",
    "JsonConfiguration": "string",
    "Description": "string",
    "Requirements": [
      "..."
    ]
  }
]

POST /integrations/endpoint

Parameters:

Name	Location	Type	Required	Description
endpoint	body	IntegrationEndpoint	No

Request Body:

Type: IntegrationEndpoint
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "Route": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "Requirements": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		IntegrationEndpoint

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "Route": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "Requirements": [
    "..."
  ]
}

PUT /integrations/endpoint

Parameters:

Name	Location	Type	Required	Description
endpoint	body	IntegrationEndpoint	No

Request Body:

Type: IntegrationEndpoint
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "Route": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "Requirements": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		IntegrationEndpoint

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "ApiName": "string",
  "ApiVersion": "string",
  "Route": "string",
  "JsonConfiguration": "string",
  "Description": "string",
  "Requirements": [
    "..."
  ]
}

IntegrationEndpointManagement

GET /integrations/endpoint/configuration

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

GET /integrations/endpoint/agents/update

Responses:

Status	Description	Type
200		`file`

IntegrationFlow

GET /integrations/flows/{integrationName}

Parameters:

Name	Location	Type	Required	Description
integrationName	path	`string`	Yes

Responses:

Status	Description	Type
200		IntegrationFlowsResponseItem

Response Example (200):

{
  "Name": "string",
  "Project": "string",
  "Version": "string",
  "PackageId": "string",
  "RequestedStatus": 0,
  "Properties": null,
  "Category": "string",
  "Labels": [
    "string"
  ],
  "AdditionalPackages": "string",
  "Requirements": [
    "..."
  ],
  "Readme": "string",
  "Files": [
    "..."
  ],
  "CamelVersion": "string"
}

PUT /integrations/flows

Parameters:

Name	Location	Type	Required	Description
flow	body	IntegrationFlow	No

Request Body:

Type: IntegrationFlow
Required: No

Request Example:

{
  "Name": "string",
  "Project": "string",
  "FlowSpec": "string",
  "Variables": null,
  "Category": "string",
  "Labels": [
    "string"
  ],
  "IntegrationFiles": [
    "..."
  ],
  "AdditionalPackages": "string",
  "Requirements": [
    "..."
  ],
  "Readme": "string"
}

Responses:

Status	Description	Type
201		IntegrationFlow

Response Example (201):

{
  "Name": "string",
  "Project": "string",
  "FlowSpec": "string",
  "Variables": null,
  "Category": "string",
  "Labels": [
    "string"
  ],
  "IntegrationFiles": [
    "..."
  ],
  "AdditionalPackages": "string",
  "Requirements": [
    "..."
  ],
  "Readme": "string"
}

POST /integrations/flows

Parameters:

Name	Location	Type	Required	Description
flow	body	IntegrationFlow	No

Request Body:

Type: IntegrationFlow
Required: No

Request Example:

{
  "Name": "string",
  "Project": "string",
  "FlowSpec": "string",
  "Variables": null,
  "Category": "string",
  "Labels": [
    "string"
  ],
  "IntegrationFiles": [
    "..."
  ],
  "AdditionalPackages": "string",
  "Requirements": [
    "..."
  ],
  "Readme": "string"
}

Responses:

Status	Description	Type
202		IntegrationFlow

GET /integrations/flows

Responses:

Status	Description	Type
200		array<IntegrationFlowDto>

Response Example (200):

[
  {
    "FlowName": "string",
    "Project": "string",
    "Status": "string",
    "RequestedStatus": "...",
    "RunningCount": 0,
    "ErrorCount": 0,
    "StoppedCount": 0,
    "UnknownCount": 0,
    "Category": "string",
    "AdditionalPackages": "string",
    "Version": "string",
    "Labels": [
      "..."
    ]
  }
]

GET /integrations/flows/{integrationName}/status

Parameters:

Name	Location	Type	Required	Description
integrationName	path	`string`	Yes

Responses:

Status	Description	Type
200		array<AgentIntegrationFlowStatus>

Response Example (200):

[
  {
    "AgentId": "00000000-0000-0000-0000-000000000000",
    "IntegrationName": "string",
    "Status": "...",
    "UpdateTime": "2024-01-01T00:00:00Z"
  }
]

POST /integrations/flows/start

Parameters:

Name	Location	Type	Required	Description
integrationFlowName	query	`string`	Yes

Responses:

Status	Description	Type
202		`void`

POST /integrations/flows/stop

Parameters:

Name	Location	Type	Required	Description
integrationFlowName	query	`string`	Yes

Responses:

Status	Description	Type
202		`void`

DELETE /integrations/flows/{integrationFlowName}

Parameters:

Name	Location	Type	Required	Description
integrationFlowName	path	`string`	Yes

Responses:

Status	Description	Type
202		`void`

GET /integrations/flows/{integrationFlowName}/logs

Parameters:

Name	Location	Type	Required	Description
integrationFlowName	path	`string`	Yes
count	query	`integer (int32)`	Yes

Responses:

Status	Description	Type
200		array<IntegrationLogMessage>

Response Example (200):

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "TimeStamp": "2024-01-01T00:00:00Z",
    "LogLevel": "string",
    "Message": "string",
    "ExceptionMessage": "string",
    "ExceptionType": "string",
    "StackTrace": "string"
  }
]

IntegrationLogs

GET /integrations/logs

Parameters:

Name	Location	Type	Required
FromDate	query	`string (date-time)`	No
ToDate	query	`string (date-time)`	No
IntegrationType	query	`string`	No
IntegrationName	query	`string`	No
AgentId	query	`string`	No
Environment	query	`string`	No
ExchangeId	query	`string`	No
LogLevel	query	`string`	No
Count	query	`integer (int32)`	No
Skip	query	`integer (int32)`	No

Responses:

Status	Description	Type
200		array<IntegrationLogItem>

Response Example (200):

[
  {
    "Timestamp": "2024-01-01T00:00:00Z",
    "Agent": "string",
    "Environment": "string",
    "ExchangeId": "string",
    "IntegrationName": "string",
    "LogLevel": "string",
    "Message": "string",
    "Stacktrace": "string",
    "Context": null
  }
]

IntegrationServices

GET /integrations/services

Responses:

Status	Description	Type
200		array<IntegrationServiceDto>

Response Example (200):

[
  {
    "Version": 0,
    "Id": "string",
    "Name": "string",
    "Title": "string",
    "Category": "string",
    "Description": "string",
    "Specification": "string",
    "Variables": null,
    "Properties": [
      "..."
    ]
  }
]

PUT /integrations/services

Parameters:

Name	Location	Type	Required	Description
newService	body	IntegrationService	No

Request Body:

Type: IntegrationService
Required: No

Request Example:

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Specification": "string",
  "Variables": null,
  "Properties": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		IntegrationService

Response Example (200):

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Specification": "string",
  "Variables": null,
  "Properties": [
    "..."
  ]
}

POST /integrations/services

Parameters:

Name	Location	Type	Required	Description
service	body	IntegrationService	No

Request Body:

Type: IntegrationService
Required: No

Request Example:

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Specification": "string",
  "Variables": null,
  "Properties": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		IntegrationService

Response Example (200):

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Specification": "string",
  "Variables": null,
  "Properties": [
    "..."
  ]
}

DELETE /integrations/services

Parameters:

Name	Location	Type	Required	Description
serviceName	query	`string`	Yes

Responses:

Status	Description	Type
200		`file`

GET /integrations/services/{serviceName}

Parameters:

Name	Location	Type	Required	Description
serviceName	path	`string`	Yes

Responses:

Status	Description	Type
200		IntegrationServiceDto

Response Example (200):

{
  "Version": 0,
  "Id": "string",
  "Name": "string",
  "Title": "string",
  "Category": "string",
  "Description": "string",
  "Specification": "string",
  "Variables": null,
  "Properties": [
    "..."
  ]
}

POST /integrations/services/{serviceName}/variables

Parameters:

Name	Location	Type	Required	Description
serviceName	path	`string`	Yes
variables	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		IntegrationService

Response Example (200):

{
  "Name": "string",
  "Title": "string",
  "Description": "string",
  "Category": "string",
  "Specification": "string",
  "Variables": null,
  "Properties": [
    "..."
  ]
}

InteractiveDocument

POST /interactive/document/analyze

Parameters:

Name	Location	Type	Required	Description
dibDocument	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		DibAnalyzationResult

Response Example (200):

{
  "OriginalDocument": "string",
  "UpdatedDocument": "string",
  "ReturnTypeName": "string",
  "ParameterNamesAndTypeNames": [
    "..."
  ]
}

POST /identity/login/username

Parameters:

Name	Location	Type	Required	Description
model	body	LoginModel	No

Request Body:

Type: LoginModel
Required: No

Request Example:

{
  "UserName": "string",
  "Password": "string"
}

Responses:

Status	Description	Type
200		LoginResult

Response Example (200):

{
  "Token": "string",
  "RefreshToken": "string"
}

POST /identity/login/refresh

Parameters:

Name	Location	Type	Required	Description
model	body	RefreshTokenModel	No

Request Body:

Type: RefreshTokenModel
Required: No

Request Example:

{
  "RefreshToken": "string"
}

Responses:

Status	Description	Type
200		LoginResult

Response Example (200):

{
  "Token": "string",
  "RefreshToken": "string"
}

Mailbox

GET /mailbox

Responses:

Status	Description	Type
200		`array<string>`
400		`void`

Response Example (200):

[
  "string"
]

POST /mailbox/initialize

Parameters:

Name	Location	Type	Required	Description
channelName	query	`string`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"00000000-0000-0000-0000-000000000000"

Mft

GET /integrations/mfts/{mftName}

Parameters:

Name	Location	Type	Required	Description
mftName	path	`string`	Yes

Responses:

Status	Description	Type
200		MftIntegration

Response Example (200):

{
  "Name": "string",
  "Project": "string",
  "Command": "string",
  "Schedule": "string",
  "Source": {
    "Name": "...",
    "Path": "..."
  },
  "Destination": {
    "Name": "...",
    "Path": "..."
  },
  "RequestedStatus": 0,
  "Requirements": [
    "..."
  ],
  "Variables": null,
  "AdditionalPackages": "string",
  "Args": "string",
  "Filters": "string",
  "Version": "string",
  "Labels": "string"
}

DELETE /integrations/mfts/{mftName}

Parameters:

Name	Location	Type	Required	Description
mftName	path	`string`	Yes

Responses:

Status	Description	Type
202		`void`

GET /integrations/mfts/{mftName}/details

Parameters:

Name	Location	Type	Required	Description
mftName	path	`string`	Yes

Responses:

Status	Description	Type
200		MftIntegrationDetails

Response Example (200):

{
  "Name": "string",
  "Project": "string",
  "Command": "string",
  "Schedule": "string",
  "Source": {
    "System": "...",
    "Path": "..."
  },
  "Destination": {
    "System": "...",
    "Path": "..."
  },
  "RequestedStatus": "...",
  "Requirements": [
    "..."
  ],
  "Variables": null,
  "AdditionalPackages": "string",
  "Args": "string",
  "Filters": "string",
  "Version": "string",
  "Labels": "string"
}

PUT /integrations/mfts

Parameters:

Name	Location	Type	Required	Description
flow	body	MftIntegration2	No

Request Body:

Type: MftIntegration2
Required: No

Request Example:

{
  "Name": "string",
  "Project": "string",
  "Command": "string",
  "Schedule": "string",
  "Source": {
    "Name": "...",
    "Path": "..."
  },
  "Destination": {
    "Name": "...",
    "Path": "..."
  },
  "RequestedStatus": 0,
  "Requirements": [
    "..."
  ],
  "Variables": null,
  "AdditionalPackages": "string",
  "Args": "string",
  "Filters": "string",
  "Version": "string",
  "Labels": "string",
  "FlowName": "string"
}

Responses:

Status	Description	Type
201		MftIntegration

Response Example (201):

{
  "Name": "string",
  "Project": "string",
  "Command": "string",
  "Schedule": "string",
  "Source": {
    "Name": "...",
    "Path": "..."
  },
  "Destination": {
    "Name": "...",
    "Path": "..."
  },
  "RequestedStatus": 0,
  "Requirements": [
    "..."
  ],
  "Variables": null,
  "AdditionalPackages": "string",
  "Args": "string",
  "Filters": "string",
  "Version": "string",
  "Labels": "string"
}

GET /integrations/mfts

Responses:

Status	Description	Type
200		array<MftDto>

Response Example (200):

[
  {
    "Name": "string",
    "Project": "string",
    "Status": "string",
    "RequestedStatus": "...",
    "RunningCount": 0,
    "ErrorCount": 0,
    "StoppedCount": 0,
    "UnknownCount": 0,
    "Category": "string",
    "Version": "string",
    "Command": "string",
    "Schedule": "string",
    "Labels": [
      "..."
    ],
    "Source": "...",
    "Destination": "..."
  }
]

GET /integrations/mfts/{integrationName}/status

Parameters:

Name	Location	Type	Required	Description
integrationName	path	`string`	Yes

Responses:

Status	Description	Type
200		array<AgentMftStatus>

Response Example (200):

[
  {
    "AgentId": "00000000-0000-0000-0000-000000000000",
    "MftName": "string",
    "Status": "...",
    "UpdateTime": "2024-01-01T00:00:00Z"
  }
]

GET /integrations/mfts/filetransfers

Parameters:

Name	Location	Type	Required
FromDate	query	`string (date-time)`	No
ToDate	query	`string (date-time)`	No
MftName	query	`string`	No
Count	query	`integer (int32)`	No
Skip	query	`integer (int32)`	No
Limit	query	`integer (int32)`	No
OnlyWhereFilesTransferred	query	`boolean`	No

Responses:

Status	Description	Type
200		array<MftFileTransferEntry>

Response Example (200):

[
  {
    "Name": "string",
    "FlowName": "string",
    "Time": "2024-01-01T00:00:00Z",
    "FileName": "string",
    "Operation": "string",
    "FromName": "string",
    "FromPath": "string",
    "FromProtocol": "string",
    "ToName": "string",
    "ToPath": "string",
    "ToProtocol": "string"
  }
]

GET /integrations/mfts/history

Parameters:

Name	Location	Type	Required
FromDate	query	`string (date-time)`	No
ToDate	query	`string (date-time)`	No
MftName	query	`string`	No
Count	query	`integer (int32)`	No
Skip	query	`integer (int32)`	No
Limit	query	`integer (int32)`	No
OnlyWhereFilesTransferred	query	`boolean`	No

Responses:

Status	Description	Type
200		array<MftScheduleExecuted>

Response Example (200):

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "StartTime": "2024-01-01T00:00:00Z",
    "MftName": "string",
    "Items": [
      "..."
    ],
    "Stats": "..."
  }
]

POST /integrations/mfts/start

Parameters:

Name	Location	Type	Required	Description
mftName	query	`string`	Yes

Responses:

Status	Description	Type
202		`void`

POST /integrations/mfts/stop

Parameters:

Name	Location	Type	Required	Description
mftName	query	`string`	Yes

Responses:

Status	Description	Type
202		`void`

GET /integrations/mfts/{name}/history/{id}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		MftScheduleExecuted

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "StartTime": "2024-01-01T00:00:00Z",
  "MftName": "string",
  "Items": [
    "..."
  ],
  "Stats": {
    "Bytes": "...",
    "Checks": "...",
    "DeletedDirs": "...",
    "Deletes": "...",
    "ElapsedTime": "...",
    "Errors": "...",
    "Eta": "...",
    "FatalError": "...",
    "Renames": "...",
    "RetryError": "...",
    "Speed": "...",
    "TotalBytes": "...",
    "TotalChecks": "...",
    "TotalTransfers": "...",
    "TransferTime": "...",
    "Transfers": "..."
  }
}

Notebook

GET /automation/notebook/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		NotebookEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "FileName": "string",
  "Content": "string"
}

DELETE /automation/notebook/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

PUT /automation/notebook/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
newContent	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		NotebookEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "FileName": "string",
  "Content": "string"
}

GET /automation/notebook

Responses:

Status	Description	Type
200		array<NotebookEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "FileName": "string",
    "Content": "string"
  }
]

POST /automation/notebook

Parameters:

Name	Location	Type	Required	Description
dto	body	NewNotebookDto	No

Request Body:

Type: NewNotebookDto
Required: No

Request Example:

{
  "FileName": "string",
  "Content": "string"
}

Responses:

Status	Description	Type
200		NotebookEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "FileName": "string",
  "Content": "string"
}

GET /automation/notebook/{id}/analyze

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		DibAnalyzationResult

Response Example (200):

{
  "OriginalDocument": "string",
  "UpdatedDocument": "string",
  "ReturnTypeName": "string",
  "ParameterNamesAndTypeNames": [
    "..."
  ]
}

POST /automation/notebook/{id}/run

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
request	body	RunNotebookRequest	No

Request Body:

Type: RunNotebookRequest
Required: No

Request Example:

{
  "PreferredFormat": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "TriggerId": "string"
}

Responses:

Status	Description	Type
200		`file`

NotebookEndpoint

GET /automation/notebook/endpoint/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<NotebookEndpoint>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "NotebookId": "00000000-0000-0000-0000-000000000000",
    "EndpointId": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "Route": "string"
  }
]

DELETE /automation/notebook/endpoint/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

PUT /automation/notebook/endpoint/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
notebookEndpoint	body	NotebookEndpoint	No

Request Body:

Type: NotebookEndpoint
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "EndpointId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Route": "string"
}

Responses:

Status	Description	Type
200		NotebookEndpoint

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "EndpointId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Route": "string"
}

GET /automation/notebook/endpoint

Responses:

Status	Description	Type
200		array<NotebookEndpoint>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "NotebookId": "00000000-0000-0000-0000-000000000000",
    "EndpointId": "00000000-0000-0000-0000-000000000000",
    "Name": "string",
    "Route": "string"
  }
]

POST /automation/notebook/endpoint

Parameters:

Name	Location	Type	Required	Description
dto	body	NotebookEndpoint	No

Request Body:

Type: NotebookEndpoint
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "EndpointId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Route": "string"
}

Responses:

Status	Description	Type
200		NotebookEndpoint

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "EndpointId": "00000000-0000-0000-0000-000000000000",
  "Name": "string",
  "Route": "string"
}

NotebookSchedule

GET /automation/notebook/schedule/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		NotebookSchedule

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "CronExpression": "string",
  "Frequency": "string",
  "Parameters": [
    "..."
  ]
}

DELETE /automation/notebook/schedule/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

PUT /automation/notebook/schedule/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
notebookSchedule	body	NotebookSchedule	No

Request Body:

Type: NotebookSchedule
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "CronExpression": "string",
  "Frequency": "string",
  "Parameters": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		NotebookSchedule

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "CronExpression": "string",
  "Frequency": "string",
  "Parameters": [
    "..."
  ]
}

GET /automation/notebook/schedule/notebook/{notebookId}

Parameters:

Name	Location	Type	Required	Description
notebookId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<NotebookSchedule>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "NotebookId": "00000000-0000-0000-0000-000000000000",
    "CronExpression": "string",
    "Frequency": "string",
    "Parameters": [
      "..."
    ]
  }
]

GET /automation/notebook/schedule

Responses:

Status	Description	Type
200		array<NotebookSchedule>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "NotebookId": "00000000-0000-0000-0000-000000000000",
    "CronExpression": "string",
    "Frequency": "string",
    "Parameters": [
      "..."
    ]
  }
]

POST /automation/notebook/schedule

Parameters:

Name	Location	Type	Required	Description
dto	body	NotebookSchedule	No

Request Body:

Type: NotebookSchedule
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "CronExpression": "string",
  "Frequency": "string",
  "Parameters": [
    "..."
  ]
}

Responses:

Status	Description	Type
200		NotebookSchedule

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "NotebookId": "00000000-0000-0000-0000-000000000000",
  "CronExpression": "string",
  "Frequency": "string",
  "Parameters": [
    "..."
  ]
}

OpenApiConnector

GET /integrations/connectors/openapi

Responses:

Status	Description	Type
200		array<OpenApiConnectorRegistryItem>

Response Example (200):

[
  {
    "Spec": "..."
  }
]

Operations

GET /schema/endpoint/operations/{endpointId}

Parameters:

Name	Location	Type	Required	Description
endpointId	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<OpenApiOperation>

Response Example (200):

[
  {
    "Method": "...",
    "Description": "string",
    "Tags": [
      "..."
    ],
    "OperationId": "string",
    "Summary": "string",
    "Url": "string",
    "Responses": [
      "..."
    ],
    "Parameters": [
      "..."
    ],
    "Requests": [
      "..."
    ]
  }
]

GET /schema/endpoint/operations/{endpointId}/details

Parameters:

Name	Location	Type	Required	Description
endpointId	path	`string (guid)`	Yes
operationId	query	`string`	Yes

Responses:

Status	Description	Type
200		OpenApiOperation

Response Example (200):

{
  "Method": {
    "Get": "...",
    "Put": "...",
    "Post": "...",
    "Delete": "...",
    "Head": "...",
    "Options": "...",
    "Trace": "...",
    "Patch": "...",
    "Connect": "...",
    "Method": "...",
    "MustHaveRequestBody": "...",
    "Http3EncodedBytes": "..."
  },
  "Description": "string",
  "Tags": [
    "string"
  ],
  "OperationId": "string",
  "Summary": "string",
  "Url": "string",
  "Responses": [
    "..."
  ],
  "Parameters": [
    "..."
  ],
  "Requests": [
    "..."
  ]
}

Publish

POST /api/EventHub/Publish

Parameters:

Name	Location	Type	Required	Description
data	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		`file`

Schedule

GET /scheduling/schedules

Responses:

Status	Description	Type
200		array<ScheduleDto>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string",
    "Cron": "string",
    "Command": "string",
    "Arguments": [
      "..."
    ]
  }
]

GET /scheduling/schedules/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		ScheduleDto

Response Example (200):

{
  "Name": "string",
  "Description": "string",
  "Cron": "string",
  "Command": "string",
  "Arguments": [
    "string"
  ]
}

ScheduleTrigger

GET /automation/triggers/schedule/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		ScheduleTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CronExpression": "string",
  "Frequency": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

DELETE /automation/triggers/schedule/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

PUT /automation/triggers/schedule/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
updatedTrigger	body	ScheduleTrigger	No

Request Body:

Type: ScheduleTrigger
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CronExpression": "string",
  "Frequency": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

Responses:

Status	Description	Type
200		ScheduleTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CronExpression": "string",
  "Frequency": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

GET /automation/triggers/schedule

Responses:

Status	Description	Type
200		array<ScheduleTrigger>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "CronExpression": "string",
    "Frequency": "string",
    "ActionId": "00000000-0000-0000-0000-000000000000",
    "ActionName": "string",
    "Parameters": [
      "..."
    ],
    "TriggerType": "string",
    "IsEnabled": false,
    "Name": "string"
  }
]

POST /automation/triggers/schedule

Parameters:

Name	Location	Type	Required	Description
newTrigger	body	ScheduleTrigger	No

Request Body:

Type: ScheduleTrigger
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CronExpression": "string",
  "Frequency": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

Responses:

Status	Description	Type
200		ScheduleTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CronExpression": "string",
  "Frequency": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

PUT /automation/triggers/schedule/{id}/enabled

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		ScheduleTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "CronExpression": "string",
  "Frequency": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

GET /automation/triggers/schedule/find

Parameters:

Name	Location	Type	Required	Description
actionId	query	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<ScheduleTrigger>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "CronExpression": "string",
    "Frequency": "string",
    "ActionId": "00000000-0000-0000-0000-000000000000",
    "ActionName": "string",
    "Parameters": [
      "..."
    ],
    "TriggerType": "string",
    "IsEnabled": false,
    "Name": "string"
  }
]

Services

GET /services

Responses:

Status	Description	Type
200		array<ServiceDto>

Response Example (200):

[
  {
    "Name": "string",
    "Version": "string",
    "Description": "string",
    "Type": "string",
    "Id": "string",
    "Metadata": null,
    "Endpoints": [
      "..."
    ]
  }
]

POST /services

Parameters:

Name	Location	Type	Required	Description
dto	body	ServiceSendDto	No

Request Body:

Type: ServiceSendDto
Required: No

Request Example:

{
  "Endpoint": "string",
  "Data": "string"
}

Responses:

Status	Description	Type
200		`void`
400		`void`

Streams

GET /eventing/streams

Responses:

Status	Description	Type
200		array<StreamInfo>

Response Example (200):

[
  {
    "Name": "string",
    "Messages": 0,
    "Created": "2024-01-01T00:00:00Z",
    "Bytes": 0,
    "IsMirror": false,
    "Replicas": 0,
    "Consumers": 0,
    "Configuration": "string"
  }
]

GET /eventing/streams/{streamName}/messages

Parameters:

Name	Location	Type	Required
streamName	path	`string`	Yes
FromDate	query	`string (date-time)`	No
ToDate	query	`string (date-time)`	No
Count	query	`integer (int32)`	No
Skip	query	`integer (int32)`	No

Responses:

Status	Description	Type
200		array<StreamMessage>

Response Example (200):

[
  {
    "Subject": "string",
    "Data": "string",
    "Timestamp": "2024-01-01T00:00:00Z",
    "Sequence": 0,
    "Headers": null
  }
]

Subscriptions

GET /api/EventHub/Subscriptions

Responses:

Status	Description	Type
200		array<ChannelSubsriptionsDto>

Response Example (200):

[
  {
    "ChannelId": "00000000-0000-0000-0000-000000000000",
    "ChannelName": "string",
    "Subscriptions": [
      "..."
    ]
  }
]

POST /api/EventHub/Subscriptions

Parameters:

Name	Location	Type	Required	Description
newSubscription	body	SubscriptionDto	No

Request Body:

Type: SubscriptionDto
Required: No

Request Example:

{
  "ChannelName": "string",
  "Source": "string",
  "EventType": "string",
  "SpecVersion": "string"
}

Responses:

Status	Description	Type
201		SubscriptionDto

Response Example (201):

{
  "ChannelName": "string",
  "Source": "string",
  "EventType": "string",
  "SpecVersion": "string"
}

DELETE /api/EventHub/Subscriptions

Parameters:

Name	Location	Type	Required	Description
removedSubscription	body	SubscriptionDto	No

Request Body:

Type: SubscriptionDto
Required: No

Request Example:

{
  "ChannelName": "string",
  "Source": "string",
  "EventType": "string",
  "SpecVersion": "string"
}

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

SystemInfo

GET /debug/systeminfo

Responses:

Status	Description	Type
200		SystemInfo

Response Example (200):

{
  "BuildDate": "2024-01-01T00:00:00Z",
  "BuildVersion": "string",
  "HostName": "string",
  "Method": "string",
  "Headers": [
    "string"
  ],
  "Scheme": "string",
  "Protocol": "string",
  "IsHttps": false,
  "RequestNetwork": "string"
}

POST /debug/systeminfo

Responses:

Status	Description	Type
200		SystemInfo

Response Example (200):

{
  "BuildDate": "2024-01-01T00:00:00Z",
  "BuildVersion": "string",
  "HostName": "string",
  "Method": "string",
  "Headers": [
    "string"
  ],
  "Scheme": "string",
  "Protocol": "string",
  "IsHttps": false,
  "RequestNetwork": "string"
}

GET /debug/systeminfo/policyreport

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

Trigger

GET /api/EventHub/Trigger

Responses:

Status	Description	Type
200		array<TriggerInstance>

Response Example (200):

[
  {
    "Id": "string",
    "Type": "string",
    "Configuration": null,
    "Status": "...",
    "CronExpression": "string",
    "Frequency": "string"
  }
]

POST /api/EventHub/Trigger

Parameters:

Name	Location	Type	Required	Description
newTrigger	body	Trigger	No

Request Body:

Type: Trigger
Required: No

Request Example:

{
  "Id": "string",
  "TypeName": "string",
  "Frequency": "string",
  "CronExpression": "string",
  "Configuration": "string",
  "TargetChannel": "string"
}

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

DELETE /api/EventHub/Trigger/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

User

GET /identity/user

Responses:

Status	Description	Type
200		array<UserDto>

Response Example (200):

[
  {
    "Username": "string",
    "Password": "string",
    "Roles": [
      "..."
    ]
  }
]

POST /identity/user

Parameters:

Name	Location	Type	Required	Description
userCreateDto	body	UserCreateDto	No

Request Body:

Type: UserCreateDto
Required: No

Request Example:

{
  "Email": "string",
  "Roles": "string"
}

Responses:

Status	Description	Type
200		UserDto
404		`void`
409		`void`

Response Example (200):

{
  "Username": "string",
  "Password": "string",
  "Roles": [
    "string"
  ]
}

DELETE /identity/user

Parameters:

Name	Location	Type	Required	Description
username	body	`string`	No

Request Body:

Type: string
Required: No

Request Example:

"string"

Responses:

Status	Description	Type
200		`void`
400		`void`
404		`void`

Variable

GET /variables

Responses:

Status	Description	Type
200		array<VariableDto>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string",
    "Value": "string",
    "IsSecret": false
  }
]

GET /variables/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		VariableDto

Response Example (200):

{
  "Name": "string",
  "Description": "string",
  "Value": "string",
  "IsSecret": false
}

GET /variables/{name}/reveal

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		`string`

Response Example (200):

"string"

WebJob

GET /automation/webjob/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		WebJobEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Command": "string",
  "CommandArguments": "string",
  "PackageId": "string",
  "PackageVersion": "string",
  "CronExpression": "string",
  "IsEnabled": false,
  "Requirements": [
    "..."
  ],
  "EnvironmentVariables": null,
  "RequestedStatus": 0
}

DELETE /automation/webjob/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		`file`

GET /automation/webjob

Responses:

Status	Description	Type
200		array<WebJobEntity>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Name": "string",
    "Command": "string",
    "CommandArguments": "string",
    "PackageId": "string",
    "PackageVersion": "string",
    "CronExpression": "string",
    "IsEnabled": false,
    "Requirements": [
      "..."
    ],
    "EnvironmentVariables": null,
    "RequestedStatus": "..."
  }
]

POST /automation/webjob

Parameters:

Name	Location	Type	Required	Description
dto	body	WebJobEntity	No

Request Body:

Type: WebJobEntity
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Command": "string",
  "CommandArguments": "string",
  "PackageId": "string",
  "PackageVersion": "string",
  "CronExpression": "string",
  "IsEnabled": false,
  "Requirements": [
    "..."
  ],
  "EnvironmentVariables": null,
  "RequestedStatus": 0
}

Responses:

Status	Description	Type
200		WebJobEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Command": "string",
  "CommandArguments": "string",
  "PackageId": "string",
  "PackageVersion": "string",
  "CronExpression": "string",
  "IsEnabled": false,
  "Requirements": [
    "..."
  ],
  "EnvironmentVariables": null,
  "RequestedStatus": 0
}

PUT /automation/webjob

Parameters:

Name	Location	Type	Required	Description
dto	body	WebJobEntity	No

Request Body:

Type: WebJobEntity
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Command": "string",
  "CommandArguments": "string",
  "PackageId": "string",
  "PackageVersion": "string",
  "CronExpression": "string",
  "IsEnabled": false,
  "Requirements": [
    "..."
  ],
  "EnvironmentVariables": null,
  "RequestedStatus": 0
}

Responses:

Status	Description	Type
200		WebJobEntity

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Name": "string",
  "Command": "string",
  "CommandArguments": "string",
  "PackageId": "string",
  "PackageVersion": "string",
  "CronExpression": "string",
  "IsEnabled": false,
  "Requirements": [
    "..."
  ],
  "EnvironmentVariables": null,
  "RequestedStatus": 0
}

POST /automation/webjob/start/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		`file`

POST /automation/webjob/stop/{name}

Parameters:

Name	Location	Type	Required	Description
name	path	`string`	Yes

Responses:

Status	Description	Type
200		`file`

WebTrigger

GET /automation/triggers/web/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		WebTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Route": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

DELETE /automation/triggers/web/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		`file`

PUT /automation/triggers/web/{id}

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes
updatedTrigger	body	WebTrigger	No

Request Body:

Type: WebTrigger
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Route": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

Responses:

Status	Description	Type
200		WebTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Route": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

GET /automation/triggers/web

Responses:

Status	Description	Type
200		array<WebTrigger>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Route": "string",
    "ActionId": "00000000-0000-0000-0000-000000000000",
    "ActionName": "string",
    "Parameters": [
      "..."
    ],
    "TriggerType": "string",
    "IsEnabled": false,
    "Name": "string"
  }
]

POST /automation/triggers/web

Parameters:

Name	Location	Type	Required	Description
newTrigger	body	WebTrigger	No

Request Body:

Type: WebTrigger
Required: No

Request Example:

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Route": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

Responses:

Status	Description	Type
200		WebTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Route": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

PUT /automation/triggers/web/{id}/enabled

Parameters:

Name	Location	Type	Required	Description
id	path	`string (guid)`	Yes

Responses:

Status	Description	Type
200		WebTrigger

Response Example (200):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "ETag": "string",
  "CreatedBy": "string",
  "CreatedDate": "2024-01-01T00:00:00Z",
  "UpdatedBy": "string",
  "UpdateDate": "2024-01-01T00:00:00Z",
  "TimeToLive": 0,
  "IsDeleted": false,
  "Route": "string",
  "ActionId": "00000000-0000-0000-0000-000000000000",
  "ActionName": "string",
  "Parameters": [
    "..."
  ],
  "TriggerType": "string",
  "IsEnabled": false,
  "Name": "string"
}

GET /automation/triggers/web/find

Parameters:

Name	Location	Type	Required	Description
actionId	query	`string (guid)`	Yes

Responses:

Status	Description	Type
200		array<WebTrigger>

Response Example (200):

[
  {
    "Id": "...",
    "ETag": "...",
    "CreatedBy": "...",
    "CreatedDate": "...",
    "UpdatedBy": "...",
    "UpdateDate": "...",
    "TimeToLive": "...",
    "IsDeleted": "...",
    "Route": "string",
    "ActionId": "00000000-0000-0000-0000-000000000000",
    "ActionName": "string",
    "Parameters": [
      "..."
    ],
    "TriggerType": "string",
    "IsEnabled": false,
    "Name": "string"
  }
]

Webhook

GET /api/webhooks

Responses:

Status	Description	Type
200		array<WebhookDto>

Response Example (200):

[
  {
    "Name": "string",
    "Description": "string"
  }
]

GET /api/webhooks/{webhookId}/history

Parameters:

Name	Location	Type	Required	Description
webhookId	path	`string`	Yes

Responses:

Status	Description	Type
200		array<WebhookRequestMessage>

Response Example (200):

[
  {
    "Id": "string",
    "Timestamp": "2024-01-01T00:00:00Z",
    "Method": "string",
    "Path": "string",
    "Headers": null,
    "QueryString": "string",
    "Body": "string",
    "ContentType": "string",
    "IsRehandled": false,
    "OriginalMessageId": "string"
  }
]

DELETE /api/webhooks/{webhookId}/history

Parameters:

Name	Location	Type	Required	Description
webhookId	path	`string`	Yes

Responses:

Status	Description	Type
200		`file`

POST /api/webhooks/{webhookId}/rehandle/{messageId}

Parameters:

Name	Location	Type	Required	Description
webhookId	path	`string`	Yes
messageId	path	`string`	Yes

Responses:

Status	Description	Type
200		`file`

Models

This section contains the schema definitions for request and response bodies.

ActionEntity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Name	`string`	No
Content	`string`	No
Parameters	array<ActionParameterTypeNameAndName>	No
DefaultParameterValues	array<ActionParameter>	No

ActionExecutionEntity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
ActionId	`string (guid)`	Yes
ActionName	`string`	No
ReceivedParameters	array<ActionParameter>	No
Parameters	array<ActionParameter>	No
StatusCode	`integer (int32)`	No
Duration	`string (duration)`	No
TriggerId	`string (guid)`	No
Error	`string`	No
Finished	`boolean`	Yes

ActionParameter

Properties:

Name	Type	Required	Description
Name	`string`	No
ValueJson	`string`	No

ActionParameterTypeNameAndName

Properties:

Name	Type	Required	Description
TypeName	`string`	No
Name	`string`	No

Agent

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Name	`string`	No
PoolName	`string`	No
Capabilities	array<AgentCapability>	No
CurrentStatusEnum	AgentStatusEnum	Yes
CurrentStatusMessage	`string`	No
IntegrationStatus	AgentEndpointManagerStatusEnum	Yes
LastSeen	`string (date-time)`	No
BaseAddress	`string`	No
LastBuildVersion	`string`	No
LastBuildDate	`string (date-time)`	No
LastUpdateDate	`string (date-time)`	No

AgentApiDefinition

Properties:

Name	Type	Required	Description
ApiName	`string`	No
ApiVersion	`string`	No

AgentCapability

Properties:

Name	Type	Required
IdentifierValueComparer	IEqualityComparerOfAgentCapability	No
Identifier	`string`	No
Value	`string`	No
IsCustom	`boolean`	Yes
CapabilityType	CapabilityType	Yes

AgentEndpointDto

Properties:

Name	Type	Required
EndpointId	`string (guid)`	Yes
AgentId	`string (guid)`	Yes
Route	`string`	No
Api	AgentApiDefinition	No
Configuration	`string`	No
CurrentStatus	EndpointStatusEnum	Yes
PreviousStatus	EndpointStatusEnum	Yes
LastStatusUpdate	`string (date-time)`	Yes
StatusUpdates	array<StatusLogOfEndpointStatusEnum>	No
EndpointName	`string`	No
EndpointRoute	`string`	No

AgentEndpointManagerStatusEnum

Type: Enum

Values:

AgentEndpointManagerStatusEnum2

Type: Enum

Values:

Initializing
Changed
Running
PartiallyRunning
Failed
Empty

AgentEndpointSchema

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
AgentId	`string (guid)`	Yes
EndpointId	`string (guid)`	Yes
Schema	`string`	No

AgentEndpointStatus

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
AgentId	`string (guid)`	Yes
EndpointId	`string (guid)`	Yes
Route	`string`	No
Configuration	`string`	No
CurrentStatus	EndpointStatusEnum	Yes
PreviousStatus	EndpointStatusEnum	Yes
LastStatusUpdate	`string (date-time)`	Yes
StatusUpdates	array<StatusLogOfEndpointStatusEnum>	No

AgentIntegrationFlowStatus

Properties:

Name	Type	Required
AgentId	`string (guid)`	Yes
IntegrationName	`string`	No
Status	IntegrationFlowStatusEnum	Yes
UpdateTime	`string (date-time)`	Yes

AgentMftStatus

Properties:

Name	Type	Required
AgentId	`string (guid)`	Yes
MftName	`string`	No
Status	MftStatus	Yes
UpdateTime	`string (date-time)`	Yes

AgentRegistrationData

Properties:

Name	Type	Required
Name	`string`	No
Token	`string`	No
InitialCapabities	array<AgentCapability>	No
InitialBaseAddress	`string`	No

AgentRegistrationDto

Properties:

Name	Type	Required
Id	`string (guid)`	Yes
Name	`string`	No
ValidationToken	`string`	No
IdentityBaseAddress	`string`	No
ConfigurationBaseAddress	`string`	No
ServerBaseAddress	`string`	No

AgentStatusEnum

Type: Enum

Values:

AgentStatusHistoryItem

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
AgentId	`string (guid)`	Yes
StatusUpdate	AgentStatusPing	No

AgentStatusPing

Properties:

Name	Type	Required
AgentId	`string (guid)`	Yes
Endpoints	array<AgentEndpointDto>	No
SystemStatus	AgentEndpointManagerStatusEnum2	Yes
AvailableApis	array<AgentApiDefinition>	No
Capabilities	array<AgentCapability>	No
BuildVersion	`string`	No
BuildDate	`string (date-time)`	No
AgentName	`string`	No
PoolName	`string`	No
BaseAddress	`string`	No
IntegrationFlowStatusList	array<IntegrationStatus>	No

AgentValidationDto

Properties:

Name	Type	Required
Id	`string (guid)`	Yes
RemoteAddress	`string`	No
ValidationToken	`string`	No

ApiAuthentication

Properties:

Name	Type	Required	Description
Type	`string`	No
Parameters	`object`	No

ApiDetailsDto

Properties:

Name	Type	Required
Versions	array<ApiVersionDto>	No
Subscriptions	array<ApiSubscription>	No
Name	`string`	No
Description	`string`	No
Prefix	`string`	No

ApiSubscription

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Apis	`array<string>`	No
Type	`string`	No
Parameters	`object`	No
AdditionalHeaders	`object`	No
Variables	`object`	No
Key	`string`	No

ApiSubscriptionDto

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Apis	`array<string>`	No
Type	`string`	No
Parameters	`string`	No
Key	`string`	No

ApiVersion

Properties:

Name	Type	Required
Version	`string`	No
ApiName	`string`	No
Description	`string`	No
IsActive	`boolean`	Yes
Type	`string`	No
Parameters	`object`	No
Variables	`object`	No
Authentication	ApiAuthentication	No
Connection	ConnectionSettings	No
Key	`string`	No

ApiVersionDto

Properties:

Name	Type	Required
Version	`string`	No
Description	`string`	No
IsActive	`boolean`	Yes
Type	`string`	No
Parameters	`string`	No
Authentication	ApiAuthentication	No
Connection	ConnectionSettings	No

AzureServiceBusDto

Properties:

Name	Type	Required
ChannelId	`string (guid)`	Yes
Name	`string`	Yes
Type	`string`	No
Queuename	`string`	No
ConnectionString	`string`	No

CapabilityType

Type: Enum

Values:

ChannelComponent

Properties:

Name	Type	Required
Type	`string`	No
Version	`string`	No
JsonConfiguration	`string`	No
Position	`integer (int32)`	Yes
ComponentTypeIdentifier	`string`	No

ChannelDto

Properties:

Name	Type	Required
ChannelId	`string (guid)`	Yes
Name	`string`	Yes
Type	`string`	No

ChannelEntity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Name	`string`	No
Type	`string`	No
AppId	`string`	No
Parameters	`object`	No
JsonConfiguration	`string`	No
Components	array<ChannelComponent>	No
Endpoints	array<ChannelComponent>	No

ChannelSubsriptionsDto

Properties:

Name	Type	Required
ChannelId	`string (guid)`	Yes
ChannelName	`string`	No
Subscriptions	`array<string>`	No

CloudEventDefinition

Properties:

Name	Type	Required
Type	`string`	No
Source	`string`	No
SpecVersion	`string`	No
DataContentType	`string`	No
DataSchemaUri	`string (uri)`	No
DataSchema	`string`	No
Tags	`array<string>`	No

CloudEventDefinitionEntity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Definition	CloudEventDefinition	No
Type	`string`	No
Source	`string`	No
SpecVersion	`string`	No
DataContentType	`string`	No
DataSchemaUri	`string (uri)`	No
DataSchema	`string`	No
Tags	`array<string>`	No

CompletionItemKind

Type: Enum

Values:

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

ComponentDto

Properties:

Name	Type	Required
Type	`string`	Yes
Version	`string`	Yes
Configuration	`string`	No
Position	`integer (int32)`	Yes

ConfigurationChangeBase

Properties:

Name	Type	Required
ApiVersion	`string`	No
Kind	`string`	No
Metadata	ConfigurationChangeMetadata	No

ConfigurationChangeBaseOfOpenApiConnectorRegistryItemSpec

Properties:

Name	Type	Required
ApiVersion	`string`	No
Kind	`string`	No
Metadata	ConfigurationChangeMetadata	No
Spec	OpenApiConnectorRegistryItemSpec	No

ConfigurationChangeMetadata

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Category	`string`	No

ConnectionSettings

Properties:

Name	Type	Required
UseProxy	`boolean`	Yes
AllowAutoRedirect	`boolean`	Yes
AutomaticDecompression	DecompressionMethods	Yes
UseCookies	`boolean`	Yes
ConnectTimeout	`string (duration)`	Yes

CoreDto

Properties:

Name	Type	Required
Name	`string`	No
Title	`string`	No
Description	`string`	No
Label	`string`	No

CoreSystem

Properties:

Name	Type	Required
Name	`string`	No
Title	`string`	No
Description	`string`	No
Category	`string`	No
Type	`string`	No
Variables	`object`	No

CoreSystem2

Properties:

Name	Type	Required
Name	`string`	No
Title	`string`	No
Description	`string`	No
Category	`string`	No
Type	`string`	No
Variables	`object`	No

CoreSystemDto

Properties:

Name	Type	Required
Name	`string`	No
Title	`string`	No
Description	`string`	No
Category	`string`	No
Type	`string`	No
Variables	`string`	No

DatabaseChangeTrackingDto

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Type	`string`	No
Parameters	`object`	No
Variables	`object`	No
CreatedAt	`string (date-time)`	Yes

DecompressionMethods

Type: Enum

Values:

0
1
2
4
-1

DibAnalyzationResult

Properties:

Name	Type	Required
OriginalDocument	`string`	No
UpdatedDocument	`string`	No
ReturnTypeName	`string`	No
ParameterNamesAndTypeNames	array<ParameterTypeNameAndName>	No

EndpointStatusEnum

Type: Enum

Values:

EndpointStatusEnum2

Type: Enum

Values:

New
Initializing
InitializingFailed
Ready
Changed
Failed
Unhealthy

Entity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes

EntityEventItem

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
EventType	`string`	No
EntityId	`string`	No
EntityType	`string`	No
Content	`string`	No
Subject	`string`	No
Source	`string`	No

EntityStoreDto

Properties:

Name	Type	Required
Type	`string`	No
Id	`string`	No
Data	`string`	No
Updated	`string (date-time)`	Yes

EntityStoreInfo

Properties:

Name	Type	Required
EntitiesStored	`integer (int64)`	Yes
EntitiesStoredIncludingHistory	`integer (uint64)`	Yes
HistoryKept	`integer (int64)`	Yes
Size	`integer (uint64)`	Yes
MaxSize	`integer (int64)`	Yes
MaximumAge	`string (duration)`	Yes

EntityStoreSearchResults

Properties:

Name	Type	Required	Description
Data	array<EntityStoreDto>	No
LimitReached	`boolean`	Yes

EventChannelDtov2

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Type	`string`	No
Parameters	`object`	No
Variables	`object`	No
Requirements	`object`	No
CreatedAt	`string (date-time)`	Yes

EventDetailsDto

Properties:

Name	Type	Required
UtcDateTime	`string (date-time)`	Yes
EventType	`string`	No
Source	`string`	No
Id	`string`	No
Version	`string`	No
Json	`string`	No
TargetChannels	`array<string>`	No

EventOverviewDto

Properties:

Name	Type	Required
UtcDateTime	`string (date-time)`	Yes
EventType	`string`	No
Source	`string`	No
Id	`string`	No

EventSourceDtov2

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Type	`string`	No
Parameters	`object`	No
Variables	`object`	No
Requirements	`object`	No
CreatedAt	`string (date-time)`	Yes

EventSourceStatus

Properties:

Name	Type	Required
Status	EventSourceStatusEnum	Yes
PreviousStatus	EventSourceStatusEnum	Yes
LastStatusUpdate	`string (date-time)`	Yes
Messages	array<StatusLogOfEventSourceStatusEnum>	No

EventSourceStatusEnum

Type: Enum

Values:

New
Initializing
Initialized
InitializingFailed
Starting
Started
Stopping
Stopped
Removed
Failed

EventSubscriptionDtov2

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Source	`string`	No
Channel	`string`	No
CreatedAt	`string (date-time)`	Yes

EventTrigger

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
EventType	`string`	No
EventSource	`string`	No
Version	`string`	No
ActionId	`string (guid)`	Yes
ActionName	`string`	No
Parameters	array<EventTriggerParameter>	No
TriggerType	`string`	No
IsEnabled	`boolean`	Yes
Name	`string`	No

EventTriggerParameter

Properties:

Name	Type	Required
Name	`string`	No
ValueJson	`string`	No
JsonPath	`string`	No

EventingComponent

Properties:

Name	Type	Required
ComponentCatalogId	`string (guid)`	Yes
CatalogName	`string`	No
CatalogVersion	`string`	No
Name	`string`	No
Version	`string`	No
ConfigurationSchema	`string`	No
Description	`string`	No
ProductVersion	`string`	No
Identifier	`string`	No

EventingComponentCatalog

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
CatalogName	`string`	No
CatalogVersion	`string`	No
Components	array<EventingComponent>	No
Status	EventingComponentCatalogStatus	Yes

EventingComponentCatalogStatus

Type: Enum

Values:

EventingEventCatalogStatus

Type: Enum

Values:

EventingEventSource

Properties:

Name	Type	Required
EventSourceCatalogId	`string (guid)`	Yes
CatalogName	`string`	No
CatalogVersion	`string`	No
Name	`string`	No
Version	`string`	No
ConfigurationSchema	`string`	No
Description	`string`	No
ProductVersion	`string`	No
RequiresPolling	`boolean`	Yes
Identifier	`string`	No

EventingEventSourceCatalog

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
CatalogName	`string`	No
CatalogVersion	`string`	No
EventSources	array<EventingEventSource>	No
Status	EventingEventCatalogStatus	Yes

EventingEventSourceCatalogAgent

Properties:

Name	Type	Required
Id	`string (guid)`	Yes
CatalogName	`string`	No
CatalogVersion	`string`	No

EventingEventSourceInstance

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Name	`string`	No
EventSourceType	`string`	No
EventSourceVersion	`string`	No
JsonConfiguration	`string`	No
Description	`string`	No
PollingFrequency	`string (duration)`	No
CronExpression	`string`	No
Requirements	array<Requirement>	No

EventingEventSourceInstanceAgent

Properties:

Name	Type	Required
EventSourceInstanceId	`string (guid)`	Yes
EventSourceId	`string`	No
Name	`string`	No
EventSourceType	`string`	No
EventSourceVersion	`string`	No
Configuration	`string`	No
PollingFrequency	`string (duration)`	No
CronExpression	`string`	No

ExecuteDibRequest

Properties:

Name	Type	Required
Dib	`string`	No
SessionId	`string`	No
Parameters	array<ExecuteDibRequestParameter>	No
PreferredFormat	`string`	No
KernelType	`string`	No
OneTimeKernel	`boolean`	Yes

ExecuteDibRequestParameter

Properties:

Name	Type	Required
Name	`string`	No
TypeName	`string`	No
ValueJson	`string`	No

ExecuteRequest

Properties:

Name	Type	Required
NotebookId	`string (guid)`	Yes
Code	`string`	No
CommandPrefix	`string`	No
FreshKernel	`boolean`	Yes
PreferredFormat	`string`	No
KernelType	`string`	No

ExecuteResult

Properties:

Name	Type	Required
Id	`string`	No
Output	`any`	No
OutputType	`string`	No
OutputJson	`string`	No
OutputString	`string`	No
DisplayString	`string`	No
FormattedResults	array<FormattedResult>	No
Duration	`string (duration)`	Yes
Time	`string (date-time)`	Yes

FormattedResult

Properties:

Name	Type	Required	Description
Type	`string`	No
Value	`string`	No

GetSuggestionsRequest

Properties:

Name	Type	Required
NotebookId	`string (guid)`	Yes
Code	`string`	No
LineNumber	`integer (int32)`	Yes
Column	`integer (int32)`	Yes

HttpChannelDto

Properties:

Name	Type	Required
ChannelId	`string (guid)`	Yes
Name	`string`	Yes
Type	`string`	No
Endpoint	`string`	Yes
BasicAuthUsername	`string`	No
BasicAuthPassword	`string`	No

HttpMethod

Properties:

Name	Type	Required
Get	HttpMethod	Yes
Put	HttpMethod	Yes
Post	HttpMethod	Yes
Delete	HttpMethod	Yes
Head	HttpMethod	Yes
Options	HttpMethod	Yes
Trace	HttpMethod	Yes
Patch	HttpMethod	Yes
Connect	HttpMethod	Yes
Method	`string`	Yes
MustHaveRequestBody	`boolean`	Yes
Http3EncodedBytes	`string (byte)`	Yes

IEqualityComparerOfAgentCapability

IntegrationApi

Properties:

Name	Type	Required
ApiPackageId	`string (guid)`	Yes
PackageName	`string`	No
PackageVersion	`string`	No
ApiName	`string`	No
ApiVersion	`string`	No
ConfigurationSchema	`string`	No
Description	`string`	No
ProductVersion	`string`	No
Identifier	`string`	No

IntegrationApiPackage

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
PackageName	`string`	No
PackageVersion	`string`	No
Apis	array<IntegrationApi>	No
Status	IntegrationApiPackageStatus	Yes

IntegrationApiPackageAgent

Properties:

Name	Type	Required
Id	`string (guid)`	Yes
PackageName	`string`	No
PackageVersion	`string`	No

IntegrationApiPackageStatus

Type: Enum

Values:

IntegrationEndpoint

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Name	`string`	No
ApiName	`string`	No
ApiVersion	`string`	No
Route	`string`	No
JsonConfiguration	`string`	No
Description	`string`	No
Requirements	array<Requirement>	No

IntegrationEndpointAgent

Properties:

Name	Type	Required
EndpointId	`string (guid)`	Yes
Name	`string`	No
Route	`string`	No
ApiName	`string`	No
ApiVersion	`string`	No
Configuration	`string`	No
EndpointStatus	EndpointStatusEnum	No

IntegrationFlow

Properties:

Name	Type	Required
Name	`string`	No
Project	`string`	No
FlowSpec	`string`	No
Variables	`object`	No
Category	`string`	No
Labels	`array<string>`	No
IntegrationFiles	array<IntegrationFlowFile>	No
AdditionalPackages	`string`	No
Requirements	array<Requirement>	No
Readme	`string`	No

IntegrationFlowDto

Properties:

Name	Type	Required
FlowName	`string`	No
Project	`string`	No
Status	`string`	No
RequestedStatus	IntegrationStatusEnum2	Yes
RunningCount	`integer (int32)`	Yes
ErrorCount	`integer (int32)`	Yes
StoppedCount	`integer (int32)`	Yes
UnknownCount	`integer (int32)`	Yes
Category	`string`	No
AdditionalPackages	`string`	No
Version	`string`	No
Labels	`array<string>`	No

IntegrationFlowFile

Properties:

Name	Type	Required	Description
FileName	`string`	No
FileContent	`string`	No

IntegrationFlowStatusEnum

Type: Enum

Values:

IntegrationFlowsResponseItem

Properties:

Name	Type	Required
Name	`string`	No
Project	`string`	No
Version	`string`	No
PackageId	`string`	No
RequestedStatus	IntegrationStatusEnum2	Yes
Properties	`object`	No
Category	`string`	No
Labels	`array<string>`	No
AdditionalPackages	`string`	No
Requirements	array<Requirement>	No
Readme	`string`	No
Files	array<IntegrationFlowFile>	No
CamelVersion	`string`	No

IntegrationLogItem

Properties:

Name	Type	Required
Timestamp	`string (date-time)`	Yes
Agent	`string`	No
Environment	`string`	No
ExchangeId	`string`	No
IntegrationName	`string`	No
LogLevel	`string`	No
Message	`string`	No
Stacktrace	`string`	No
Context	`object`	No

IntegrationLogMessage

Properties:

Name	Type	Required
Id	`string (guid)`	Yes
TimeStamp	`string (date-time)`	Yes
LogLevel	`string`	No
Message	`string`	No
ExceptionMessage	`string`	No
ExceptionType	`string`	No
StackTrace	`string`	No

IntegrationService

Properties:

Name	Type	Required
Name	`string`	No
Title	`string`	No
Description	`string`	No
Category	`string`	No
Specification	`string`	No
Variables	`object`	No
Properties	array<IntegrationServiceProperty>	No

IntegrationServiceDto

Properties:

Name	Type	Required
Version	`integer (uint64)`	Yes
Id	`string`	No
Name	`string`	No
Title	`string`	No
Category	`string`	No
Description	`string`	No
Specification	`string`	No
Variables	`object`	No
Properties	array<IntegrationServiceProperty>	No

IntegrationServiceProperty

Properties:

Name	Type	Required
Name	`string`	No
Title	`string`	No
Description	`string`	No
Type	`string`	No
Default	`string`	No
Example	`string`	No
IsRequired	`boolean`	Yes

IntegrationStatistics

Properties:

Name	Type	Required
Load01	`string`	No
Load05	`string`	No
Load15	`string`	No
ExchangesThroughput	`string`	No
ExchangesTotal	`integer (int32)`	Yes
ExchangesFailed	`integer (int32)`	Yes
ExchangesInflight	`integer (int32)`	Yes
Reloaded	`integer (int32)`	Yes
MeanProcessingTime	`integer (int32)`	Yes
MaxProcessingTime	`integer (int32)`	Yes
MinProcessingTime	`integer (int32)`	Yes
LastProcessingTime	`integer (int32)`	Yes
DeltaProcessingTime	`integer (int32)`	Yes
SinceLastCreatedExchange	`string`	No
SinceLastCompletedExchange	`string`	No

IntegrationStatus

Properties:

Name	Type	Required
IntegrationName	`string`	No
Pid	`integer (int64)`	Yes
IntegrationFile	`string`	No
IntegrationFilePath	`string`	No
WorkingDirectory	`string`	No
State	`string`	No
UpTime	`string`	No
Statistics	IntegrationStatistics	No
LogMessages	array<IntegrationLogMessage>	No

IntegrationStatusEnum

Type: Enum

Values:

IntegrationStatusEnum2

Type: Enum

Values:

Items

Properties:

Name	Type	Required
Level	`string`	No
Msg	`string`	No
Source	`string`	No
Time	`string`	No
Object	`string`	No
ObjectType	`string`	No
Stats	MftStats	No

KeyValuePairOfStringAndString

Properties:

Name	Type	Required	Description
Key	`string`	No
Value	`string`	No

LoginModel

Properties:

Name	Type	Required	Description
UserName	`string`	No
Password	`string`	No

LoginResult

Properties:

Name	Type	Required	Description
Token	`string`	No
RefreshToken	`string`	No

MftDto

Properties:

Name	Type	Required
Name	`string`	No
Project	`string`	No
Status	`string`	No
RequestedStatus	IntegrationStatusEnum2	Yes
RunningCount	`integer (int32)`	Yes
ErrorCount	`integer (int32)`	Yes
StoppedCount	`integer (int32)`	Yes
UnknownCount	`integer (int32)`	Yes
Category	`string`	No
Version	`string`	No
Command	`string`	No
Schedule	`string`	No
Labels	`array<string>`	No
Source	MftStorageDetails2	No
Destination	MftStorageDetails2	No

MftFileTransferEntry

Properties:

Name	Type	Required
Name	`string`	No
FlowName	`string`	No
Time	`string (date-time)`	Yes
FileName	`string`	No
Operation	`string`	No
FromName	`string`	No
FromPath	`string`	No
FromProtocol	`string`	No
ToName	`string`	No
ToPath	`string`	No
ToProtocol	`string`	No

MftIntegration

Properties:

Name	Type	Required
Name	`string`	No
Project	`string`	No
Command	`string`	No
Schedule	`string`	No
Source	MftStorage	No
Destination	MftStorage	No
RequestedStatus	IntegrationStatusEnum	Yes
Requirements	array<Requirement2>	No
Variables	`object`	No
AdditionalPackages	`string`	No
Args	`string`	No
Filters	`string`	No
Version	`string`	No
Labels	`string`	No

MftIntegration2

Properties:

Name	Type	Required
Name	`string`	No
Project	`string`	No
Command	`string`	No
Schedule	`string`	No
Source	MftStorage2	No
Destination	MftStorage2	No
RequestedStatus	IntegrationStatusEnum2	Yes
Requirements	array<Requirement>	No
Variables	`object`	No
AdditionalPackages	`string`	No
Args	`string`	No
Filters	`string`	No
Version	`string`	No
Labels	`string`	No
FlowName	`string`	No

MftIntegrationDetails

Properties:

Name	Type	Required
Name	`string`	No
Project	`string`	No
Command	`string`	No
Schedule	`string`	No
Source	MftStorageDetails	No
Destination	MftStorageDetails	No
RequestedStatus	IntegrationStatusEnum	Yes
Requirements	array<Requirement2>	No
Variables	`object`	No
AdditionalPackages	`string`	No
Args	`string`	No
Filters	`string`	No
Version	`string`	No
Labels	`string`	No

MftScheduleExecuted

Properties:

Name	Type	Required
Id	`string (guid)`	Yes
StartTime	`string (date-time)`	Yes
MftName	`string`	No
Items	array<Items>	No
Stats	MftStats	No

MftStats

Properties:

Name	Type	Required
Bytes	`integer (int32)`	Yes
Checks	`integer (int32)`	Yes
DeletedDirs	`integer (int32)`	Yes
Deletes	`integer (int32)`	Yes
ElapsedTime	`number (double)`	Yes
Errors	`integer (int32)`	Yes
Eta	`any`	No
FatalError	`boolean`	Yes
Renames	`integer (int32)`	Yes
RetryError	`boolean`	Yes
Speed	`number (double)`	Yes
TotalBytes	`integer (int32)`	Yes
TotalChecks	`integer (int32)`	Yes
TotalTransfers	`integer (int32)`	Yes
TransferTime	`number (double)`	Yes
Transfers	`integer (int32)`	Yes

MftStatus

Type: Enum

Values:

MftStorage

Properties:

Name	Type	Required	Description
Name	`string`	No
Path	`string`	No

MftStorage2

Properties:

Name	Type	Required	Description
Name	`string`	No
Path	`string`	No

MftStorageDetails

Properties:

Name	Type	Required	Description
System	CoreSystem	No
Path	`string`	No

MftStorageDetails2

Properties:

Name	Type	Required	Description
System	CoreSystem2	No
Path	`string`	No

NewActionDto

Properties:

Name	Type	Required	Description
Name	`string`	No
Content	`string`	No

NewChannelDto

Properties:

Name	Type	Required
Name	`string`	Yes
Type	`string`	No
Configuration	`string`	No
Components	array<ComponentDto>	No
Endpoints	array<ComponentDto>	No
AppId	`string`	No

NewNotebookDto

Properties:

Name	Type	Required	Description
FileName	`string`	No
Content	`string`	No

NotebookEndpoint

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
NotebookId	`string (guid)`	Yes
EndpointId	`string (guid)`	Yes
Name	`string`	No
Route	`string`	No

NotebookEntity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
FileName	`string`	No
Content	`string`	No

NotebookSchedule

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Name	`string`	No
NotebookId	`string (guid)`	Yes
CronExpression	`string`	No
Frequency	`string (duration)`	No
Parameters	array<RunNotebookParameter>	No

OpenApiConnectorRegistryItem

OpenApiConnectorRegistryItemSpec

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Package	`string`	No
Version	`string`	No
Labels	`array<string>`	No

OpenApiOperation

Properties:

Name	Type	Required
Method	HttpMethod	No
Description	`string`	No
Tags	`array<string>`	No
OperationId	`string`	No
Summary	`string`	No
Url	`string`	No
Responses	array<OpenApiOperationResponse>	No
Parameters	array<OpenApiOperationParameter>	No
Requests	array<OpenApiOperationRequest>	No

OpenApiOperationField

Properties:

Name	Type	Required
Name	`string`	No
Type	`string`	No
Description	`string`	No

OpenApiOperationParameter

Properties:

Name	Type	Required
Name	`string`	No
Type	`string`	No
Description	`string`	No
Required	`boolean`	Yes
Kind	OpenApiOperationParameterKind	Yes
Options	`array<any>`	No

OpenApiOperationParameterKind

Type: Enum

Values:

OpenApiOperationRequest

Properties:

Name	Type	Required	Description
RequestContentType	`string`	No
Fields	array<OpenApiOperationField>	No

OpenApiOperationResponse

Properties:

Name	Type	Required
HTTPResponseCode	`integer (int32)`	Yes
HTTPResponseMessage	`string`	No
Description	`string`	No
ResponseContentType	`string`	No
Fields	array<OpenApiOperationField>	No

ParameterTypeNameAndName

Properties:

Name	Type	Required	Description
TypeName	`string`	No
Name	`string`	No

PendingAgentRegistration

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
PoolName	`string`	No
Expires	`string (date-time)`	Yes

PendingAgentRegistrationDto

Properties:

Name	Type	Required
Id	`string (guid)`	Yes
ServerBaseaddress	`string`	No
Token	`string`	No

RefreshTokenModel

Properties:

Name	Type	Required	Description
RefreshToken	`string`	No

Requirement

Properties:

Name	Type	Required	Description
Identifier	`string`	No
Value	`string`	No

Requirement2

Properties:

Name	Type	Required	Description
Identifier	`string`	No
Value	`string`	No

RunActionRequest

Properties:

Name	Type	Required
PreferredFormat	`string`	No
Parameters	array<ActionParameter>	No
TriggerId	`string (guid)`	No
TriggerType	`string`	No

RunNotebookParameter

Properties:

Name	Type	Required	Description
Name	`string`	No
ValueJson	`string`	No

RunNotebookRequest

Properties:

Name	Type	Required
PreferredFormat	`string`	No
Parameters	array<RunNotebookParameter>	No
TriggerType	`string`	No
TriggerId	`string`	No

ScheduleDto

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Cron	`string`	No
Command	`string`	No
Arguments	`array<string>`	No

ScheduleTrigger

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
CronExpression	`string`	No
Frequency	`string (duration)`	No
ActionId	`string (guid)`	Yes
ActionName	`string`	No
Parameters	array<ActionParameter>	No
TriggerType	`string`	No
IsEnabled	`boolean`	Yes
Name	`string`	No

ServiceDto

Properties:

Name	Type	Required
Name	`string`	No
Version	`string`	No
Description	`string`	No
Type	`string`	No
Id	`string`	No
Metadata	`object`	No
Endpoints	array<ServiceEndpointDto>	No

ServiceEndpointDto

Properties:

Name	Type	Required
Name	`string`	No
Version	`string`	No
Endpoint	`string`	No
Metadata	`object`	No

ServiceSendDto

Properties:

Name	Type	Required	Description
Endpoint	`string`	No
Data	`string (byte)`	No

StatusBaseOfEventSourceStatusEnum

Properties:

Name	Type	Required
Status	EventSourceStatusEnum	Yes
PreviousStatus	EventSourceStatusEnum	Yes
LastStatusUpdate	`string (date-time)`	Yes
Messages	array<StatusLogOfEventSourceStatusEnum>	No

StatusLogOfEndpointStatusEnum

Properties:

Name	Type	Required
PreviousStatus	EndpointStatusEnum2	Yes
NewStatus	EndpointStatusEnum2	Yes
LogTime	`string (date-time)`	Yes
Message	`string`	No

StatusLogOfEventSourceStatusEnum

Properties:

Name	Type	Required
PreviousStatus	EventSourceStatusEnum	Yes
NewStatus	EventSourceStatusEnum	Yes
LogTime	`string (date-time)`	Yes
Message	`string`	No

StorageDto

Properties:

Name	Type	Required	Description
Name	`string`	No
Description	`string`	No

StreamInfo

Properties:

Name	Type	Required
Name	`string`	No
Messages	`integer (uint64)`	Yes
Created	`string (date-time)`	Yes
Bytes	`integer (uint64)`	Yes
IsMirror	`boolean`	Yes
Replicas	`integer (int32)`	Yes
Consumers	`integer (int64)`	Yes
Configuration	`string`	No

StreamMessage

Properties:

Name	Type	Required
Subject	`string`	No
Data	`string (byte)`	No
Timestamp	`string (date-time)`	Yes
Sequence	`integer (uint64)`	Yes
Headers	`object`	No

SubscriptionDto

Properties:

Name	Type	Required
ChannelName	`string`	Yes
Source	`string`	No
EventType	`string`	No
SpecVersion	`string`	No

SubscriptionEntity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
ChannelId	`string (guid)`	Yes
ChannelName	`string`	No
EventType	`string`	No
AppId	`string`	No
SpecVersion	`string`	No
Source	`string`	No

Suggestion

Properties:

Name	Type	Required
Label	`string`	No
InsertText	`string`	No
Kind	CompletionItemKind	Yes
Documentation	`string`	No

SystemInfo

Properties:

Name	Type	Required
BuildDate	`string (date-time)`	No
BuildVersion	`string`	No
HostName	`string`	No
Method	`string`	No
Headers	`array<string>`	No
Scheme	`string`	No
Protocol	`string`	No
IsHttps	`boolean`	Yes
RequestNetwork	`string`	No

Trigger

Properties:

Name	Type	Required
Id	`string`	No
TypeName	`string`	No
Frequency	`string (duration)`	No
CronExpression	`string`	No
Configuration	`string`	No
TargetChannel	`string`	No

TriggerInstance

Properties:

Name	Type	Required
Id	`string`	No
Type	`string`	No
Configuration	`any`	No
Status	EventSourceStatus	No
CronExpression	`string`	No
Frequency	`string (duration)`	No

TriggerType

Properties:

Name	Type	Required
Name	`string`	No
Version	Version	No
Description	`string`	No
Configuration	TriggerTypeConfiguration	No

TriggerTypeConfiguration

Properties:

Name	Type	Required	Description
RequiresPolling	`boolean`	Yes
ConfigurationSchema	`string`	No

UserCreateDto

Properties:

Name	Type	Required	Description
Email	`string`	No
Roles	`string`	No

UserDto

Properties:

Name	Type	Required
Username	`string`	No
Password	`string`	No
Roles	`array<string>`	No

VariableDto

Properties:

Name	Type	Required
Name	`string`	No
Description	`string`	No
Value	`string`	No
IsSecret	`boolean`	Yes

Version

Properties:

Name	Type	Required
Major	`integer (int32)`	Yes
Minor	`integer (int32)`	Yes
Build	`integer (int32)`	Yes
Revision	`integer (int32)`	Yes
MajorRevision	`integer`	Yes
MinorRevision	`integer`	Yes
DefaultFormatFieldCount	`integer (int32)`	Yes

WebJobEntity

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Name	`string`	No
Command	`string`	No
CommandArguments	`string`	No
PackageId	`string`	No
PackageVersion	`string`	No
CronExpression	`string`	No
IsEnabled	`boolean`	Yes
Requirements	array<Requirement>	No
EnvironmentVariables	`object`	No
RequestedStatus	WebJobStatus	Yes

WebJobStatus

Type: Enum

Values:

WebTrigger

Properties:

Name	Type	Required
Id	`string (guid)`	No
ETag	`string`	No
CreatedBy	`string`	No
CreatedDate	`string (date-time)`	Yes
UpdatedBy	`string`	No
UpdateDate	`string (date-time)`	No
TimeToLive	`integer (int32)`	No
IsDeleted	`boolean`	Yes
Route	`string`	No
ActionId	`string (guid)`	Yes
ActionName	`string`	No
Parameters	array<ActionParameter>	No
TriggerType	`string`	No
IsEnabled	`boolean`	Yes
Name	`string`	No

WebhookDto

Properties:

Name	Type	Required	Description
Name	`string`	No
Description	`string`	No

WebhookRequestMessage

Properties:

Name	Type	Required
Id	`string`	No
Timestamp	`string (date-time)`	Yes
Method	`string`	No
Path	`string`	No
Headers	`object`	No
QueryString	`string`	No
Body	`string`	No
ContentType	`string`	No
IsRehandled	`boolean`	Yes
OriginalMessageId	`string`	No