POST api/EventBus/Settings

Request Information

URI Parameters

None.

Body Parameters

WorkPoint.Core.Models.EventBus.EventBusSettings
NameDescriptionTypeAdditional information
Target

WorkPoint.Core.Models.EventBus.EventBusTarget

None.

EndpointUrl

string

None.

AccessTokenCredentialGuid

globally unique identifier

None.

Events

Collection of WorkPoint.Core.Models.EventBus.TriggerEvent

None.

Request Formats

application/json, text/json

Sample:
{
  "Target": "AzureEventGrid",
  "EndpointUrl": "sample string 1",
  "AccessTokenCredentialGuid": "240052a3-cb27-45f4-87c4-36047e8bf4aa",
  "Events": [
    {
      "type": "EntityTriggerEvent",
      "WorkPointEventType": "EntityCreated",
      "AzureEventType": "sample string 1",
      "BusinessModuleId": "5f4d1bb9-dc46-47d1-ab35-0c25fd871326",
      "ListRelativeUrl": "sample string 3",
      "Subject": "sample string 4",
      "DataVersion": "sample string 5"
    },
    {
      "type": "EntityTriggerEvent",
      "WorkPointEventType": "EntityCreated",
      "AzureEventType": "sample string 1",
      "BusinessModuleId": "5f4d1bb9-dc46-47d1-ab35-0c25fd871326",
      "ListRelativeUrl": "sample string 3",
      "Subject": "sample string 4",
      "DataVersion": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<EventBusSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint.Core.Models.EventBus">
  <AccessTokenCredentialGuid>240052a3-cb27-45f4-87c4-36047e8bf4aa</AccessTokenCredentialGuid>
  <EndpointUrl>sample string 1</EndpointUrl>
  <Events>
    <TriggerEvent>
      <AzureEventType>sample string 1</AzureEventType>
      <BusinessModuleId>5f4d1bb9-dc46-47d1-ab35-0c25fd871326</BusinessModuleId>
      <Category>EntityTriggerEvent</Category>
      <DataVersion>sample string 5</DataVersion>
      <ListRelativeUrl>sample string 3</ListRelativeUrl>
      <Subject>sample string 4</Subject>
      <WorkPointEventType>EntityCreated</WorkPointEventType>
    </TriggerEvent>
    <TriggerEvent>
      <AzureEventType>sample string 1</AzureEventType>
      <BusinessModuleId>5f4d1bb9-dc46-47d1-ab35-0c25fd871326</BusinessModuleId>
      <Category>EntityTriggerEvent</Category>
      <DataVersion>sample string 5</DataVersion>
      <ListRelativeUrl>sample string 3</ListRelativeUrl>
      <Subject>sample string 4</Subject>
      <WorkPointEventType>EntityCreated</WorkPointEventType>
    </TriggerEvent>
  </Events>
  <Target>AzureEventGrid</Target>
</EventBusSettings>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.