WebProtégé API 1.0.0

Operations

• PUB webprotege.application.GetApplicationSettings

  Accepts the following message:

  GetApplicationSettingsRequest

  Payload

  object

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #application

  Examples

  Payload

  {}
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.application.GetApplicationSettings-Replies

  Accepts the following message:

  GetApplicationSettingsResponse

  Payload

  object

  settings

  object

  An object that represents the application settings

  applicationName

  string

  The human readable application name

  systemNotificationEmailAddress

  string

  format: email

  An email address that critical system notifications will be sent to

  applicationLocation

  object

  An object that represents the Web location of the application.

  scheme

  string

  host

  string

  path

  string

  port

  integer

  Additional properties are NOT allowed.

  accountCreationSetting

  string

  Allowed values:
  • "ACCOUNT_CREATION_ALLOWED"
  • "ACCOUNT_CREATION_NOT_ALLOWED"

  accountCreators

  array<string>

  A list of users that are allowed to create accounts. May be empty.

  Items:

  string

  projectCreationSetting

  string

  Allowed values:
  • "EMPTY_PROJECT_CREATION_ALLOWED"
  • "EMPTY_PROJECT_CREATION_NOT_ALLOWED"

  projectCreators

  array<string>

  A list of users that are allowed to create projects. May be empty.

  Items:

  string

  projectUploadSetting

  string

  Allowed values:
  • "PROJECT_UPLOAD_ALLOWED"
  • "PROJECT_UPLOAD_NOT_ALLOWED"

  projectUploaders

  array<string>

  A list of users that are allowed to upload ontologies. May be empty.

  Items:

  string

  notificationEmailsSetting

  string

  Allowed values:
  • "SEND_NOTIFICATION_EMAILS"
  • "DO_NOT_SEND_NOTIFICATION_EMAILS"

  maxUploadSize

  integer

  The maximum upload size in Megabytes

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "settings": {
      "applicationName": "string",
      "systemNotificationEmailAddress": "user@example.com",
      "applicationLocation": {
        "scheme": "string",
        "host": "string",
        "path": "string",
        "port": 0
      },
      "accountCreationSetting": "ACCOUNT_CREATION_ALLOWED",
      "accountCreators": [
        "string"
      ],
      "projectCreationSetting": "EMPTY_PROJECT_CREATION_ALLOWED",
      "projectCreators": [
        "string"
      ],
      "projectUploadSetting": "PROJECT_UPLOAD_ALLOWED",
      "projectUploaders": [
        "string"
      ],
      "notificationEmailsSetting": "SEND_NOTIFICATION_EMAILS",
      "maxUploadSize": 0
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.application.SetApplicationSettings

  Accepts the following message:

  SetApplicationSettingsRequest

  Payload

  object

  applicationSettings

  object

  An object that represents the application settings

  applicationName

  string

  The human readable application name

  systemNotificationEmailAddress

  string

  format: email

  An email address that critical system notifications will be sent to

  applicationLocation

  object

  An object that represents the Web location of the application.

  scheme

  string

  host

  string

  path

  string

  port

  integer

  Additional properties are NOT allowed.

  accountCreationSetting

  string

  Allowed values:
  • "ACCOUNT_CREATION_ALLOWED"
  • "ACCOUNT_CREATION_NOT_ALLOWED"

  accountCreators

  array<string>

  A list of users that are allowed to create accounts. May be empty.

  Items:

  string

  projectCreationSetting

  string

  Allowed values:
  • "EMPTY_PROJECT_CREATION_ALLOWED"
  • "EMPTY_PROJECT_CREATION_NOT_ALLOWED"

  projectCreators

  array<string>

  A list of users that are allowed to create projects. May be empty.

  Items:

  string

  projectUploadSetting

  string

  Allowed values:
  • "PROJECT_UPLOAD_ALLOWED"
  • "PROJECT_UPLOAD_NOT_ALLOWED"

  projectUploaders

  array<string>

  A list of users that are allowed to upload ontologies. May be empty.

  Items:

  string

  notificationEmailsSetting

  string

  Allowed values:
  • "SEND_NOTIFICATION_EMAILS"
  • "DO_NOT_SEND_NOTIFICATION_EMAILS"

  maxUploadSize

  integer

  The maximum upload size in Megabytes

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #application

  Examples

  Payload

  {
    "applicationSettings": {
      "applicationName": "string",
      "systemNotificationEmailAddress": "user@example.com",
      "applicationLocation": {
        "scheme": "string",
        "host": "string",
        "path": "string",
        "port": 0
      },
      "accountCreationSetting": "ACCOUNT_CREATION_ALLOWED",
      "accountCreators": [
        "string"
      ],
      "projectCreationSetting": "EMPTY_PROJECT_CREATION_ALLOWED",
      "projectCreators": [
        "string"
      ],
      "projectUploadSetting": "PROJECT_UPLOAD_ALLOWED",
      "projectUploaders": [
        "string"
      ],
      "notificationEmailsSetting": "SEND_NOTIFICATION_EMAILS",
      "maxUploadSize": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.application.SetApplicationSettings-Replies

  Accepts the following message:

  SetApplicationSettingsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.auth.GetProjectPermissions

  Accepts the following message:

  GetProjectPermissionsRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #auth

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.auth.GetProjectPermissions-Replies

  Accepts the following message:

  GetProjectPermissionsResponse

  Payload

  object

  allowedActions

  array<string>

  Items:

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "allowedActions": [
      "string"
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.auth.RebuildPermissions

  Accepts the following message:

  RebuildPermissionsRequest

  Payload

  object

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #auth

  Examples

  Payload

  {}
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.auth.RebuildPermissions-Replies

  Accepts the following message:

  RebuildPermissionsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.authorization.GetAssignedRoles

  Accepts the following message:

  GetAssignedRolesRequest

  Payload

  object

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #authorization

  Examples

  Payload

  {
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.authorization.GetAssignedRoles-Replies

  Accepts the following message:

  <anonymous-message-10>

  Payload

  object

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  roles

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "roles": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.authorization.GetAuthorizationStatus

  Accepts the following message:

  GetAuthorizationStatusRequest

  Payload

  object

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  actionId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #authorization

  Examples

  Payload

  {
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "actionId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.authorization.GetAuthorizationStatus-Replies

  Accepts the following message:

  <anonymous-message-12>

  Payload

  object

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  authorizationStatus

  string

  Allowed values:
  • "AUTHORIZED"
  • "UNAUTHORIZED"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "authorizationStatus": "AUTHORIZED"
  }
  

  This example has been generated automatically.

• PUB webprotege.authorization.GetAuthorizedActions

  Accepts the following message:

  GetAuthorizedActionsRequest

  Payload

  object

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that will be echoed in the reply to this message.

  Additional properties are allowed.

  • #authorization

  Examples

  Payload

  {
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "subject": {
      "userId": "string",
      "@type": "User"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• PUB webprotege.authorization.GetAuthorizedResources

  Accepts the following message:

  GetAuthorizedResourcesRequest

  Payload

  object

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  actionId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #authorization

  Examples

  Payload

  {
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "actionId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.authorization.GetAuthorizedResources-Replies

  Accepts the following message:

  <anonymous-message-15>

  Payload

  object

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  actionId

  string

  resources

  array<anyOf>

  Items:

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "actionId": "string",
    "resources": [
      {
        "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.authorization.GetAuthorizedSubjects

  Accepts the following message:

  GetAuthorizedSubjectsRequest

  Payload

  object

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  actionId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #authorization

  Examples

  Payload

  {
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "actionId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.authorization.GetAuthorizedSubjects-Replies

  Accepts the following message:

  <anonymous-message-17>

  Payload

  object

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  actionId

  string

  subjects

  array<anyOf>

  Items:

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "actionId": "string",
    "subjects": [
      {
        "userId": "string",
        "@type": "User"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.authorization.GetRoles

  Accepts the following message:

  <anonymous-message-18>

  Payload

  object

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #authorization

  Examples

  Payload

  {
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.authorization.GetRoles-Replies

  Accepts the following message:

  <anonymous-message-19>

  Payload

  object

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  roles

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "roles": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.authorization.SetAssignedRoles

  Accepts the following message:

  SetAssignedRolesRequest

  Payload

  object

  subject

  anyOf

  Can adhere to:

  allOf

  Consists of:

  object

  userId

  string

  Additional properties are NOT allowed.

  And with:

  object

  @type

  string

  Const:"User"

  Additional properties are allowed.

  Or to:

  object

  @type

  string

  Const:"AnyUser"

  Additional properties are NOT allowed.

  resource

  anyOf

  Can adhere to:

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  roles

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #authorization

  Examples

  Payload

  {
    "subject": {
      "userId": "string",
      "@type": "User"
    },
    "resource": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
    },
    "roles": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.authorization.SetAssignedRoles-Replies

  Accepts the following message:

  <anonymous-message-21>

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.bulkop.DeleteAnnotations

  Accepts the following message:

  DeleteAnnotationsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  criteria

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #bulkop

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {
        "iri": "http://example.com",
        "type": "Class"
      }
    ],
    "criteria": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.bulkop.DeleteAnnotations-Replies

  Accepts the following message:

  DeleteAnnotationsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.bulkop.EditAnnotations

  Accepts the following message:

  EditAnnotationsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  operation

  string

  Allowed values:
  • "REPLACE"
  • "DELETE"
  • "AUGMENT"

  property

  object | null

  iri

  string

  format: iri

  type

  string

  Const:"owl:AnnotationProperty"

  Additional properties are NOT allowed.

  lexicalValueExpression

  string | null

  lexicalValueExpressionIsRegEx

  boolean

  langTagExpression

  string | null

  newAnnotationData

  object

  Additional properties are NOT allowed.

  commitMessage

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #bulkop

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {
        "iri": "http://example.com",
        "type": "Class"
      }
    ],
    "operation": "REPLACE",
    "property": {
      "iri": "http://example.com",
      "type": "owl:AnnotationProperty"
    },
    "lexicalValueExpression": "string",
    "lexicalValueExpressionIsRegEx": true,
    "langTagExpression": "string",
    "newAnnotationData": {},
    "commitMessage": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.bulkop.EditAnnotations-Replies

  Accepts the following message:

  EditAnnotationsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.bulkop.SetAnnotationValue

  Accepts the following message:

  SetAnnotationValueRequest

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  property

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:AnnotationProperty"

  Additional properties are NOT allowed.

  value

  object

  Additional properties are NOT allowed.

  commitMessage

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #bulkop

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {
        "iri": "http://example.com",
        "type": "Class"
      }
    ],
    "property": {
      "iri": "http://example.com",
      "type": "owl:AnnotationProperty"
    },
    "value": {},
    "commitMessage": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.bulkop.SetAnnotationValue-Replies

  Accepts the following message:

  SetAnnotationValueResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.discussions.AddComment

  Accepts the following message:

  AddCommentRequest

  Payload

  object

  projectId

  string

  format: uuid

  threadId

  string

  format: uuid

  comment

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "comment": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.AddComment-Replies

  Accepts the following message:

  AddCommentResponse

  Payload

  object

  projectId

  string

  format: uuid

  threadId

  string

  format: uuid

  comment

  object

  id

  string

  format: uuid

  createdBy

  string

  createdAt

  integer

  updatedAt

  integer

  body

  string

  renderedBody

  string

  Additional properties are NOT allowed.

  commentRendering

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "comment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "createdBy": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "body": "string",
      "renderedBody": "string"
    },
    "commentRendering": "string"
  }
  

  This example has been generated automatically.

• PUB webprotege.discussions.AddIssueComment

  Accepts the following message:

  AddIssueCommentRequest

  Payload

  object

  projectId

  string

  format: uuid

  issueNumber

  integer

  comment

  object

  id

  string

  format: uuid

  createdBy

  string

  createdAt

  integer

  updatedAt

  integer

  body

  string

  renderedBody

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "issueNumber": 0,
    "comment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "createdBy": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "body": "string",
      "renderedBody": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.AddIssueComment-Replies

  Accepts the following message:

  AddIssueCommentResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.discussions.CreateEntityDiscussionThread

  Accepts the following message:

  CreateEntityDiscussionThreadRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  comment

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "comment": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.CreateEntityDiscussionThread-Replies

  Accepts the following message:

  CreateEntityDiscussionThreadResponse

  Payload

  object

  threads

  array<object>

  projectId

  string

  format: uuid

  id

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  status

  string

  Allowed values:
  • "OPEN"
  • "CLOSED"

  comments

  array<object>

  id

  string

  format: uuid

  createdBy

  string

  createdAt

  integer

  updatedAt

  integer

  body

  string

  renderedBody

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "threads": [
      {
        "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "entity": {
          "iri": "http://example.com",
          "type": "Class"
        },
        "status": "OPEN",
        "comments": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "createdBy": "string",
            "createdAt": 0,
            "updatedAt": 0,
            "body": "string",
            "renderedBody": "string"
          }
        ]
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.discussions.DeleteComment

  Accepts the following message:

  DeleteCommentRequest

  Payload

  object

  projectId

  string

  format: uuid

  commentId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.DeleteComment-Replies

  Accepts the following message:

  DeleteCommentResponse

  Payload

  object

  commentId

  string

  format: uuid

  deleted

  boolean

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
    "deleted": true
  }
  

  This example has been generated automatically.

• PUB webprotege.discussions.GetCommentedEntities

  Accepts the following message:

  GetCommentedEntitiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  userIdFilter

  string

  statusFilter

  array<string>

  Items:

  string

  Allowed values:
  • "OPEN"
  • "CLOSED"

  sortingKey

  string

  Allowed values:
  • "SORT_BY_ENTITY"
  • "SORT_BY_LAST_MODIFIED"

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userIdFilter": "string",
    "statusFilter": [
      "OPEN"
    ],
    "sortingKey": "SORT_BY_ENTITY",
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.GetCommentedEntities-Replies

  Accepts the following message:

  GetCommentedEntitiesResponse

  Payload

  object

  projectId

  string

  format: uuid

  entities

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.discussions.GetEntityDiscussionThreads

  Accepts the following message:

  GetEntityDiscussionThreadsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.GetEntityDiscussionThreads-Replies

  Accepts the following message:

  GetEntityDiscussionThreadsResponse

  Payload

  object

  entity

  anyOf

  Can adhere to:

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDataPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLAnnotationPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLNamedIndividualData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDatatypeData"

  Additional properties are NOT allowed.

  threads

  array<object>

  projectId

  string

  format: uuid

  id

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  status

  string

  Allowed values:
  • "OPEN"
  • "CLOSED"

  comments

  array<object>

  id

  string

  format: uuid

  createdBy

  string

  createdAt

  integer

  updatedAt

  integer

  body

  string

  renderedBody

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "entity": {
      "type": "OWLClassData"
    },
    "threads": [
      {
        "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "entity": {
          "iri": "http://example.com",
          "type": "Class"
        },
        "status": "OPEN",
        "comments": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "createdBy": "string",
            "createdAt": 0,
            "updatedAt": 0,
            "body": "string",
            "renderedBody": "string"
          }
        ]
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.discussions.SetDiscussionThreadStatus

  Accepts the following message:

  SetDiscussionThreadStatusRequest

  Payload

  object

  projectId

  string

  format: uuid

  threadId

  string

  format: uuid

  status

  string

  Allowed values:
  • "OPEN"
  • "CLOSED"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "status": "OPEN"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.SetDiscussionThreadStatus-Replies

  Accepts the following message:

  SetDiscussionThreadStatusResponse

  Payload

  object

  threadId

  string

  format: uuid

  result

  string

  Allowed values:
  • "OPEN"
  • "CLOSED"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "result": "OPEN"
  }
  

  This example has been generated automatically.

• PUB webprotege.discussions.UpdateComment

  Accepts the following message:

  UpdateCommentRequest

  Payload

  object

  projectId

  string

  format: uuid

  threadId

  string

  format: uuid

  commentId

  string

  format: uuid

  body

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #discussions

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "threadId": "51f72284-0555-48fe-a20a-4369ee94dc3e",
    "commentId": "ee0469af-2fa1-4b7e-b5f1-8e711a95821b",
    "body": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.discussions.UpdateComment-Replies

  Accepts the following message:

  UpdateCommentResponse

  Payload

  object

  editedComment

  object | null

  id

  string

  format: uuid

  createdBy

  string

  createdAt

  integer

  updatedAt

  integer

  body

  string

  renderedBody

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "editedComment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "createdBy": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "body": "string",
      "renderedBody": "string"
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.CreateAnnotationProperties

  Accepts the following message:

  CreateAnnotationPropertiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  sourceText

  string

  langTag

  string

  parents

  array<object>

  iri

  string

  format: iri

  type

  string

  Const:"owl:AnnotationProperty"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "sourceText": "string",
    "langTag": "string",
    "parents": [
      {
        "iri": "http://example.com",
        "type": "owl:AnnotationProperty"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.CreateAnnotationProperties-Replies

  Accepts the following message:

  CreateAnnotationPropertiesResponse

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.CreateClasses

  Accepts the following message:

  CreateClassesRequest

  Payload

  object

  Represents a request to create OWL classes in a specified project

  projectId

  string

  format: uuid

  The id of the project where the classes will be created

  sourceText

  string

  The source text that contains the user supplied names for the classes.

  Multiple user-supplied class names should be separated with a new line.

  langTag

  string

  The language tag that should be used for the labels of the created classes

  parents

  array<object>

  A set of classes that the created classes will be subclasses of.

  May be empty.

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "sourceText": "string",
    "langTag": "string",
    "parents": [
      {
        "iri": "http://example.com",
        "type": "owl:Class"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.CreateClasses-Replies

  Accepts the following message:

  CreateClassesResponse

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.CreateDataProperties

  Accepts the following message:

  CreateDataPropertiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  sourceText

  string

  langTag

  string

  parents

  array<object>

  iri

  string

  format: iri

  type

  string

  Const:"owl:DatatypeProperty"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "sourceText": "string",
    "langTag": "string",
    "parents": [
      {
        "iri": "http://example.com",
        "type": "owl:DatatypeProperty"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.CreateDataProperties-Replies

  Accepts the following message:

  CreateDataPropertiesResponse

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.CreateNamedIndividuals

  Accepts the following message:

  CreateNamedIndividualsRequest

  Payload

  object

  projectId

  string

  format: uuid

  sourceText

  string

  langTag

  string

  types

  array<object>

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "sourceText": "string",
    "langTag": "string",
    "types": [
      {
        "iri": "http://example.com",
        "type": "owl:Class"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.CreateNamedIndividuals-Replies

  Accepts the following message:

  CreateNamedIndividualsResponse

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.CreateObjectProperties

  Accepts the following message:

  CreateObjectPropertiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  sourceText

  string

  langTag

  string

  parents

  array<object>

  iri

  string

  format: iri

  type

  string

  Const:"owl:ObjectProperty"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "sourceText": "string",
    "langTag": "string",
    "parents": [
      {
        "iri": "http://example.com",
        "type": "owl:ObjectProperty"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.CreateObjectProperties-Replies

  Accepts the following message:

  CreateObjectPropertiesResponse

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.DeleteEntitiesAction

  Accepts the following message:

  DeleteEntitiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {
        "iri": "http://example.com",
        "type": "Class"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.DeleteEntitiesAction-Replies

  Accepts the following message:

  DeleteEntitiesResponse

  Payload

  object

  deletedEntities

  array<object>

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "deletedEntities": [
      {
        "iri": "http://example.com",
        "type": "Class"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.GetDeprecatedEntities

  Accepts the following message:

  GetDeprecatedEntitiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  entityTypes

  array<string>

  Items:

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    },
    "entityTypes": [
      "Class"
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.GetDeprecatedEntities-Replies

  Accepts the following message:

  GetDeprecatedEntitiesResponse

  Payload

  object

  entities

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "entities": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.GetEntityCrudKits

  Accepts the following message:

  GetEntityCrudKitsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.GetEntityCrudKits-Replies

  Accepts the following message:

  GetEntityCrudKitsResponse

  Payload

  object

  kits

  array<object>

  kitId

  object

  lexicalForm

  string

  Additional properties are NOT allowed.

  displayName

  string

  currentSettings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "kits": [
      {
        "kitId": {
          "lexicalForm": "string"
        },
        "displayName": "string"
      }
    ],
    "currentSettings": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.GetEntityRendering

  Accepts the following message:

  GetEntityRenderingRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.GetEntityRendering-Replies

  Accepts the following message:

  GetEntityRenderingResponse

  Payload

  object

  entityData

  anyOf

  Can adhere to:

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDataPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLAnnotationPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLNamedIndividualData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDatatypeData"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "entityData": {
      "type": "OWLClassData"
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.GetIndividuals

  Accepts the following message:

  GetIndividualsRequest

  Payload

  object

  projectId

  string

  format: uuid

  type

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  searchString

  string

  instanceRetrievalMode

  string

  Allowed values:
  • "ALL_INSTANCES"
  • "DIRECT_INSTANCES"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "type": {
      "iri": "http://example.com",
      "type": "owl:Class"
    },
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    },
    "searchString": "string",
    "instanceRetrievalMode": "ALL_INSTANCES"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.GetIndividuals-Replies

  Accepts the following message:

  GetIndividualsResponse

  Payload

  object

  type

  anyOf

  Can adhere to:

  null

  Or to:

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  individuals

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "type": null,
    "individuals": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.GetIndividualsPageContainingIndividual

  Accepts the following message:

  GetIndividualsPageContainingIndividualRequest

  Payload

  object

  projectId

  string

  format: uuid

  individual

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:NamedIndividual"

  Additional properties are NOT allowed.

  preferredType

  object | null

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  preferredMode

  string

  Allowed values:
  • "ALL_INSTANCES"
  • "DIRECT_INSTANCES"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "individual": {
      "iri": "http://example.com",
      "type": "owl:NamedIndividual"
    },
    "preferredType": {
      "iri": "http://example.com",
      "type": "owl:Class"
    },
    "preferredMode": "ALL_INSTANCES"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.GetIndividualsPageContainingIndividual-Replies

  Accepts the following message:

  GetIndividualsPageContainingIndividualResponse

  Payload

  object

  individual

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:NamedIndividual"

  Additional properties are NOT allowed.

  page

  object

  Additional properties are NOT allowed.

  actualType

  object

  Additional properties are NOT allowed.

  actualMode

  string

  Allowed values:
  • "ALL_INSTANCES"
  • "DIRECT_INSTANCES"

  types

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "individual": {
      "iri": "http://example.com",
      "type": "owl:NamedIndividual"
    },
    "page": {},
    "actualType": {},
    "actualMode": "ALL_INSTANCES",
    "types": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.GetMatchingEntities

  Accepts the following message:

  GetMatchingEntitiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  criteria

  anyOf

  Can adhere to:

  restricted any anyOf

  Can adhere to:

  restricted any anyOf

  Can adhere to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  restricted any anyOf

  Can adhere to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  restricted any anyOf

  Can adhere to:

  restricted any anyOf

  Can adhere to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  restricted any anyOf

  Can adhere to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  restricted any anyOf

  Can adhere to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "criteria": {},
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.GetMatchingEntities-Replies

  Accepts the following message:

  GetMatchingEntitiesResponse

  Payload

  object

  entities

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "entities": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.LookupEntities

  Accepts the following message:

  LookupEntitiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  entityLookupRequest

  object

  entityMatchCriteria

  object

  Additional properties are NOT allowed.

  searchString

  string

  searchType

  string

  Allowed values:
  • "EXACT_MATCH"
  • "EXACT_MATCH_IGNORE_CASE"
  • "SUB_STRING_MATCH_IGNORE_CASE"

  searchedEntityTypes

  array<string>

  Items:

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  searchLimit

  integer

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entityLookupRequest": {
      "entityMatchCriteria": {},
      "searchString": "string",
      "searchType": "EXACT_MATCH",
      "searchedEntityTypes": [
        "Class"
      ],
      "searchLimit": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.LookupEntities-Replies

  Accepts the following message:

  LookupEntitiesResponse

  Payload

  object

  results

  array<object>

  matchResult

  object

  Additional properties are NOT allowed.

  directLink

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "results": [
      {
        "matchResult": {},
        "directLink": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.entities.MergeEntities

  Accepts the following message:

  MergeEntitiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  sourceEntities

  array<object>

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  targetEntity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  treatment

  string

  Allowed values:
  • "DELETE_MERGED_ENTITY"
  • "DEPRECATE_MERGED_ENTITY"

  commitMessage

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "sourceEntities": [
      {
        "iri": "http://example.com",
        "type": "Class"
      }
    ],
    "targetEntity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "treatment": "DELETE_MERGED_ENTITY",
    "commitMessage": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.MergeEntities-Replies

  Accepts the following message:

  MergeEntitiesResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.entities.MoveEntitiesToParent

  Accepts the following message:

  MoveEntitiesToParentRequest

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<object>

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  parentEntity

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  commitMessage

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #entities

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {
        "iri": "http://example.com",
        "type": "owl:Class"
      }
    ],
    "parentEntity": {
      "iri": "http://example.com",
      "type": "owl:Class"
    },
    "commitMessage": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.entities.MoveEntitiesToParent-Replies

  Accepts the following message:

  MoveEntitiesToParentResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.forms.CopyFormDescriptors

  Accepts the following message:

  CopyFormDescriptorsRequest

  Payload

  object

  toProject

  string

  format: uuid

  fromProject

  string

  format: uuid

  formIds

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "toProject": "58a259bc-1cb9-4e27-ad33-6a9ecfdbc231",
    "fromProject": "f4bd2f98-fd65-4e41-9caa-5e16604d6b84",
    "formIds": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.CopyFormDescriptors-Replies

  Accepts the following message:

  CopyFormDescriptorsResponse

  Payload

  object

  copiedFormDescriptors

  array<object>

  formId

  object

  Additional properties are NOT allowed.

  label

  object

  Additional properties are NOT allowed.

  subjectFactoryDescriptor

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "copiedFormDescriptors": [
      {
        "formId": {},
        "label": {},
        "subjectFactoryDescriptor": {}
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.forms.CreateEntityFromFormData

  Accepts the following message:

  CreateEntityFromFormDataRequest

  Payload

  object

  projectId

  string

  format: uuid

  entityType

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  freshEntityIri

  object

  Additional properties are NOT allowed.

  formData

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entityType": "Class",
    "freshEntityIri": {},
    "formData": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.CreateEntityFromFormData-Replies

  Accepts the following message:

  CreateEntityFromFormDataResponse

  Payload

  object

  projectId

  string

  format: uuid

  entities

  array<anyOf>

  Items:

  anyOf

  Can adhere to:

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDataPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLAnnotationPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLNamedIndividualData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDatatypeData"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entities": [
      {
        "type": "OWLClassData"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.forms.DeleteForm

  Accepts the following message:

  DeleteFormRequest

  Payload

  object

  projectId

  string

  format: uuid

  formId

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "formId": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.DeleteForm-Replies

  Accepts the following message:

  DeleteFormResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.forms.DeprecateEntityByFormAction

  Accepts the following message:

  DeprecateEntityByFormRequest

  Payload

  object

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  deprecationFormData

  object

  Additional properties are NOT allowed.

  replacementEntity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "deprecationFormData": {},
    "replacementEntity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.DeprecateEntityByFormAction-Replies

  Accepts the following message:

  DeprecateEntityByFormResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.forms.GetEntityCreationForms

  Accepts the following message:

  GetEntityCreationFormsRequest

  Payload

  object

  projectId

  string

  format: uuid

  parentEntity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  entityType

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "parentEntity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "entityType": "Class"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.GetEntityCreationForms-Replies

  Accepts the following message:

  GetEntityCreationFormsResponse

  Payload

  object

  formDescriptors

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "formDescriptors": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.forms.GetEntityDeprecationForms

  Accepts the following message:

  GetEntityDeprecationFormsRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.GetEntityDeprecationForms-Replies

  Accepts the following message:

  GetEntityDeprecationFormsResponse

  Payload

  object

  formDtos

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  referencesCount

  integer

  replacementEntityCriteria

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "formDtos": [
      {}
    ],
    "referencesCount": 0,
    "replacementEntityCriteria": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.forms.GetEntityFormDescriptor

  Accepts the following message:

  GetEntityFormDescriptorRequest

  Payload

  object

  projectId

  string

  format: uuid

  formId

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "formId": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.GetEntityFormDescriptor-Replies

  Accepts the following message:

  GetEntityFormDescriptorResponse

  Payload

  object

  projectId

  string

  format: uuid

  formId

  object

  Additional properties are NOT allowed.

  formDescriptor

  object

  formId

  object

  Additional properties are NOT allowed.

  label

  object

  Additional properties are NOT allowed.

  subjectFactoryDescriptor

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  purpose

  string

  Allowed values:
  • "ENTITY_CREATION"
  • "ENTITY_EDITING"
  • "ENTITY_DEPRECATION"

  selectorCriteria

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "formId": {},
    "formDescriptor": {
      "formId": {},
      "label": {},
      "subjectFactoryDescriptor": {}
    },
    "purpose": "ENTITY_CREATION",
    "selectorCriteria": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.forms.GetEntityForms

  Accepts the following message:

  GetEntityFormsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  formPageRequests

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  langTagFilter

  object

  Additional properties are NOT allowed.

  orderings

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  filters

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  formRegionFilters

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "formPageRequests": [
      {}
    ],
    "langTagFilter": {},
    "orderings": [
      {}
    ],
    "filters": [
      {}
    ],
    "formRegionFilters": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.GetEntityForms-Replies

  Accepts the following message:

  GetEntityFormsResponse

  Payload

  object

  entityData

  anyOf

  Can adhere to:

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDataPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLAnnotationPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLNamedIndividualData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDatatypeData"

  Additional properties are NOT allowed.

  filteredFormIds

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  formData

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "entityData": {
      "type": "OWLClassData"
    },
    "filteredFormIds": [
      {}
    ],
    "formData": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.forms.GetProjectFormDescriptors

  Accepts the following message:

  GetProjectFormDescriptorsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.GetProjectFormDescriptors-Replies

  Accepts the following message:

  GetProjectFormDescriptorsResponse

  Payload

  object

  projectId

  string

  format: uuid

  formDescriptors

  array<object>

  formId

  object

  Additional properties are NOT allowed.

  label

  object

  Additional properties are NOT allowed.

  subjectFactoryDescriptor

  object

  Additional properties are NOT allowed.

  formSelectors

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "formDescriptors": [
      {
        "formId": {},
        "label": {},
        "subjectFactoryDescriptor": {}
      }
    ],
    "formSelectors": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.forms.SetEntityFormDescriptor

  Accepts the following message:

  SetEntityFormDescriptorRequest

  Payload

  object

  projectId

  string

  format: uuid

  formDescriptor

  object

  formId

  object

  Additional properties are NOT allowed.

  label

  object

  Additional properties are NOT allowed.

  subjectFactoryDescriptor

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  purpose

  string

  Allowed values:
  • "ENTITY_CREATION"
  • "ENTITY_EDITING"
  • "ENTITY_DEPRECATION"

  selectorCriteria

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "formDescriptor": {
      "formId": {},
      "label": {},
      "subjectFactoryDescriptor": {}
    },
    "purpose": "ENTITY_CREATION",
    "selectorCriteria": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.SetEntityFormDescriptor-Replies

  Accepts the following message:

  SetEntityFormDescriptorResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.forms.SetEntityFormsData

  Accepts the following message:

  SetEntityFormsDataRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  pristineFormsData

  object

  Additional properties are NOT allowed.

  editedFormsData

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "pristineFormsData": {},
    "editedFormsData": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.SetEntityFormsData-Replies

  Accepts the following message:

  SetEntityFormsDataResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.forms.UpdateFormDescriptor

  Accepts the following message:

  UpdateFormDescriptorRequest

  Payload

  object

  projectId

  string

  format: uuid

  formDescriptor

  object

  formId

  object

  Additional properties are NOT allowed.

  label

  object

  Additional properties are NOT allowed.

  subjectFactoryDescriptor

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #forms

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "formDescriptor": {
      "formId": {},
      "label": {},
      "subjectFactoryDescriptor": {}
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.forms.UpdateFormDescriptor-Replies

  Accepts the following message:

  UpdateFormDescriptorResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.frames.GetAnnotationPropertyFrame

  Accepts the following message:

  GetAnnotationPropertyFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  subject

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:AnnotationProperty"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "subject": {
      "iri": "http://example.com",
      "type": "owl:AnnotationProperty"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.GetAnnotationPropertyFrame-Replies

  Accepts the following message:

  GetAnnotationPropertyFrameResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.frames.GetClassFrame

  Accepts the following message:

  GetClassFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  subject

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "subject": {
      "iri": "http://example.com",
      "type": "owl:Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.GetClassFrame-Replies

  Accepts the following message:

  GetClassFrameResponse

  Payload

  object

  frame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "frame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.GetDataPropertyFrame

  Accepts the following message:

  GetDataPropertyFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  subject

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:DatatypeProperty"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "subject": {
      "iri": "http://example.com",
      "type": "owl:DatatypeProperty"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.GetDataPropertyFrame-Replies

  Accepts the following message:

  GetDataPropertyFrameResponse

  Payload

  object

  frame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "frame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.GetNamedIndividualFrame

  Accepts the following message:

  GetNamedIndividualFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  subject

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:NamedIndividual"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "subject": {
      "iri": "http://example.com",
      "type": "owl:NamedIndividual"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.GetNamedIndividualFrame-Replies

  Accepts the following message:

  GetNamedIndividualFrameResponse

  Payload

  object

  frame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "frame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.GetObjectPropertyFrame

  Accepts the following message:

  GetObjectPropertyFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  subject

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:ObjectProperty"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "subject": {
      "iri": "http://example.com",
      "type": "owl:ObjectProperty"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.GetObjectPropertyFrame-Replies

  Accepts the following message:

  GetObjectPropertyFrameResponse

  Payload

  object

  projectId

  string

  format: uuid

  frame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "frame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.GetOntologyFrames

  Accepts the following message:

  GetOntologyFramesRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.GetOntologyFrames-Replies

  Accepts the following message:

  GetOntologyFramesResponse

  Payload

  object

  frames

  array<object>

  shortForm

  string

  propertyValueList

  object

  propertyValues

  array<anyOf>

  Items:

  anyOf

  Can adhere to:

  object

  type

  string

  Const:"PropertyClassValue"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"PropertyIndividualValue"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"PropertyDatatypeValue"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"PropertyLiteralValue"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"PropertyAnnotationValue"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "frames": [
      {
        "shortForm": "string",
        "propertyValueList": {
          "propertyValues": [
            {
              "type": "PropertyClassValue"
            }
          ]
        }
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.UpdateAnnotationPropertyFrame

  Accepts the following message:

  UpdateAnnotationPropertyFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  from

  object

  type

  string

  Const:"AnnotationPropertyFrame"

  Additional properties are NOT allowed.

  to

  object

  type

  string

  Const:"AnnotationPropertyFrame"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "from": {
      "type": "AnnotationPropertyFrame"
    },
    "to": {
      "type": "AnnotationPropertyFrame"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.UpdateAnnotationPropertyFrame-Replies

  Accepts the following message:

  UpdateAnnotationPropertyFrameResponse

  Payload

  object

  updatedFrame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "updatedFrame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.UpdateClassFrame

  Accepts the following message:

  UpdateClassFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  from

  object

  type

  string

  Const:"ClassFrame"

  Additional properties are NOT allowed.

  to

  object

  type

  string

  Const:"ClassFrame"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "from": {
      "type": "ClassFrame"
    },
    "to": {
      "type": "ClassFrame"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.UpdateClassFrame-Replies

  Accepts the following message:

  UpdateClassFrameResponse

  Payload

  object

  updatedFrame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "updatedFrame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.UpdateDataPropertyFrame

  Accepts the following message:

  UpdateDataPropertyFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  from

  object

  type

  string

  Const:"DataPropertyFrame"

  Additional properties are NOT allowed.

  to

  object

  type

  string

  Const:"DataPropertyFrame"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "from": {
      "type": "DataPropertyFrame"
    },
    "to": {
      "type": "DataPropertyFrame"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.UpdateDataPropertyFrame-Replies

  Accepts the following message:

  UpdateDataPropertyFrameResponse

  Payload

  object

  updatedFrame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "updatedFrame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.UpdateNamedIndividualFrame

  Accepts the following message:

  UpdateNamedIndividualFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  from

  object

  type

  string

  Const:"IndividualFrame"

  Additional properties are NOT allowed.

  to

  object

  type

  string

  Const:"IndividualFrame"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "from": {
      "type": "IndividualFrame"
    },
    "to": {
      "type": "IndividualFrame"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.UpdateNamedIndividualFrame-Replies

  Accepts the following message:

  UpdateNamedIndividualFrameResponse

  Payload

  object

  updatedFrame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "updatedFrame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.frames.UpdateObjectPropertyFrame

  Accepts the following message:

  UpdateObjectPropertyFrameRequest

  Payload

  object

  projectId

  string

  format: uuid

  from

  object

  type

  string

  Const:"ObjectPropertyFrame"

  Additional properties are NOT allowed.

  to

  object

  type

  string

  Const:"ObjectPropertyFrame"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #frames

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "from": {
      "type": "ObjectPropertyFrame"
    },
    "to": {
      "type": "ObjectPropertyFrame"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.frames.UpdateObjectPropertyFrame-Replies

  Accepts the following message:

  UpdateObjectPropertyFrameResponse

  Payload

  object

  updatedFrame

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "updatedFrame": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.graphs.GetEntityGraph

  Accepts the following message:

  GetEntityGraphRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #graphs

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.graphs.GetEntityGraph-Replies

  Accepts the following message:

  GetEntityGraphResponse

  Payload

  object

  graph

  object

  Additional properties are NOT allowed.

  settings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "graph": {},
    "settings": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.graphs.GetProjectEntityGraphDefaultEdgeCriteria

  Accepts the following message:

  GetProjectEntityGraphDefaultEdgeCriteriaRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #graphs

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.graphs.GetProjectEntityGraphDefaultEdgeCriteria-Replies

  Accepts the following message:

  GetProjectEntityGraphDefaultEdgeCriteriaResponse

  Payload

  object

  edgeCriteria

  array<anyOf>

  Items:

  anyOf

  Can adhere to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Or to:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "edgeCriteria": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.graphs.GetUserProjectEntityGraphCriteria

  Accepts the following message:

  GetUserProjectEntityGraphCriteriaRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #graphs

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.graphs.GetUserProjectEntityGraphCriteria-Replies

  Accepts the following message:

  GetUserProjectEntityGraphCriteriaResponse

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  settings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string",
    "settings": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.graphs.SetEntityGraphActiveFilters

  Accepts the following message:

  SetEntityGraphActiveFiltersRequest

  Payload

  object

  projectId

  string

  format: uuid

  activeFilters

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #graphs

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "activeFilters": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.graphs.SetEntityGraphActiveFilters-Replies

  Accepts the following message:

  SetEntityGraphActiveFiltersResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.graphs.SetUserProjectEntityGraphSettings

  Accepts the following message:

  SetUserProjectEntityGraphSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  settings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #graphs

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string",
    "settings": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.graphs.SetUserProjectEntityGraphSettings-Replies

  Accepts the following message:

  SetUserProjectEntityGraphSettingsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.hierarchies.GetHierarchyChildren

  Accepts the following message:

  GetHierarchyChildrenRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  hierarchyId

  string

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #hierarchies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "hierarchyId": "string",
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.hierarchies.GetHierarchyChildren-Replies

  Accepts the following message:

  GetHierarchyChildrenResponse

  Payload

  object

  parent

  object

  userObject

  any

  sink

  boolean

  Additional properties are NOT allowed.

  children

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "parent": {
      "userObject": null,
      "sink": true
    },
    "children": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.hierarchies.GetHierarchyPathsToRoot

  Accepts the following message:

  GetHierarchyPathsToRootRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  hierarchyId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #hierarchies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "hierarchyId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.hierarchies.GetHierarchyPathsToRoot-Replies

  Accepts the following message:

  GetHierarchyPathsToRootResponse

  Payload

  object

  paths

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "paths": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.hierarchies.GetHierarchyRoots

  Accepts the following message:

  GetHierarchyRootsRequest

  Payload

  object

  projectId

  string

  format: uuid

  hierarchyId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #hierarchies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "hierarchyId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.hierarchies.GetHierarchyRoots-Replies

  Accepts the following message:

  GetHierarchyRootsResponse

  Payload

  object

  rootNodes

  array<object>

  userObject

  object

  Additional properties are NOT allowed.

  sink

  boolean

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "rootNodes": [
      {
        "userObject": {},
        "sink": true
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.hierarchies.GetHierarchySiblings

  Accepts the following message:

  GetHierarchySiblingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  hierarchyId

  string

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #hierarchies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "hierarchyId": "string",
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.hierarchies.GetHierarchySiblings-Replies

  Accepts the following message:

  GetHierarchySiblingsResponse

  Payload

  object

  siblingsPage

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "siblingsPage": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.hierarchies.MoveHierarchyNode

  Accepts the following message:

  MoveHierarchyNodeRequest

  Payload

  object

  projectId

  string

  format: uuid

  hierarchyId

  string

  fromNodePath

  object

  Additional properties are NOT allowed.

  toNodeParentPath

  object

  Additional properties are NOT allowed.

  dropType

  string

  Allowed values:
  • "MOVE"
  • "ADD"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #hierarchies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "hierarchyId": "string",
    "fromNodePath": {},
    "toNodeParentPath": {},
    "dropType": "MOVE"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.hierarchies.MoveHierarchyNode-Replies

  Accepts the following message:

  MoveHierarchyNodeResponse

  Payload

  object

  moved

  boolean

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "moved": true
  }
  

  This example has been generated automatically.

• PUB webprotege.history.GetHeadRevisionNumber

  Accepts the following message:

  GetHeadRevisionNumberRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #history

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.history.GetHeadRevisionNumber-Replies

  Accepts the following message:

  GetHeadRevisionNumberResponse

  Payload

  object

  projectId

  string

  format: uuid

  revisionNumber

  number

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "revisionNumber": 0
  }
  

  This example has been generated automatically.

• PUB webprotege.history.GetProjectChanges

  Accepts the following message:

  GetProjectChangesRequest

  Payload

  object

  projectId

  string

  format: uuid

  subject

  object | null

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #history

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "subject": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.history.GetProjectChanges-Replies

  Accepts the following message:

  GetProjectChangesResponse

  Payload

  object

  projectChanges

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectChanges": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.history.GetRevisionSummaries

  Accepts the following message:

  GetRevisionSummariesRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #history

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.history.GetRevisionSummaries-Replies

  Accepts the following message:

  GetRevisionSummariesResponse

  Payload

  object

  revisionSummaries

  array<object>

  revisionNumber

  number

  userId

  string

  timestamp

  integer

  changeCount

  integer

  description

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "revisionSummaries": [
      {
        "revisionNumber": 0,
        "userId": "string",
        "timestamp": 0,
        "changeCount": 0,
        "description": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.history.RevertRevision

  Accepts the following message:

  RevertRevisionRequest

  Payload

  object

  projectId

  string

  format: uuid

  revisionNumber

  number

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #history

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "revisionNumber": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.history.RevertRevision-Replies

  Accepts the following message:

  RevertRevisionResponse

  Payload

  object

  projectId

  string

  format: uuid

  revisionNumber

  number

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "revisionNumber": 0
  }
  

  This example has been generated automatically.

• PUB webprotege.html.GetEntityHtmlRendering

  Accepts the following message:

  GetEntityHtmlRenderingRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #html

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.html.GetEntityHtmlRendering-Replies

  Accepts the following message:

  GetEntityHtmlRenderingResponse

  Payload

  object

  entityData

  anyOf

  Can adhere to:

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDataPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLAnnotationPropertyData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLNamedIndividualData"

  Additional properties are NOT allowed.

  Or to:

  object

  type

  string

  Const:"OWLDatatypeData"

  Additional properties are NOT allowed.

  rendering

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "entityData": {
      "type": "OWLClassData"
    },
    "rendering": "string"
  }
  

  This example has been generated automatically.

• PUB webprotege.issues.GetIssues

  Accepts the following message:

  GetIssuesRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #issues

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.issues.GetIssues-Replies

  Accepts the following message:

  GetIssuesResponse

  Payload

  object

  issues

  array<object>

  projectId

  string

  format: uuid

  number

  integer

  creator

  string

  createdAt

  integer

  updatedAt

  integer

  targetEntities

  array<object>

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  title

  string

  body

  string

  status

  string

  Allowed values:
  • "OPEN"
  • "CLOSED"

  assignees

  array<string>

  Items:

  string

  milestone

  object

  label

  string

  Additional properties are NOT allowed.

  lockSetting

  string

  Allowed values:
  • "LOCKED"
  • "UNLOCKED"

  labels

  array<string>

  Items:

  string

  comments

  array<object>

  id

  string

  format: uuid

  createdBy

  string

  createdAt

  integer

  updatedAt

  integer

  body

  string

  renderedBody

  string

  mentions

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  participants

  array<string>

  Items:

  string

  events

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "issues": [
      {
        "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
        "number": 0,
        "creator": "string",
        "createdAt": 0,
        "updatedAt": 0,
        "targetEntities": [
          {
            "iri": "http://example.com",
            "type": "Class"
          }
        ],
        "title": "string",
        "body": "string",
        "status": "OPEN",
        "assignees": [
          "string"
        ],
        "milestone": {
          "label": "string"
        },
        "lockSetting": "LOCKED",
        "labels": [
          "string"
        ],
        "comments": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "createdBy": "string",
            "createdAt": 0,
            "updatedAt": 0,
            "body": "string",
            "renderedBody": "string"
          }
        ],
        "mentions": [
          {}
        ],
        "participants": [
          "string"
        ],
        "events": [
          {}
        ]
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.GetOBOTermCrossProduct

  Accepts the following message:

  GetOboTermCrossProductRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.GetOBOTermCrossProduct-Replies

  Accepts the following message:

  GetOboTermCrossProductResponse

  Payload

  object

  crossProduct

  object

  genus

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  relationships

  object

  relationships

  array<object>

  relation

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  value

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "crossProduct": {
      "genus": {
        "type": "OWLClassData"
      },
      "relationships": {
        "relationships": [
          {
            "relation": {
              "type": "OWLObjectPropertyData"
            },
            "value": {
              "type": "OWLClassData"
            }
          }
        ]
      }
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.GetOboNamespaces

  Accepts the following message:

  GetOboNamespacesRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.GetOboNamespaces-Replies

  Accepts the following message:

  GetOboNamespacesResponse

  Payload

  object

  namespaces

  array<object>

  namespace

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "namespaces": [
      {
        "namespace": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.GetOboTermDefinition

  Accepts the following message:

  GetOboTermDefinitionRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.GetOboTermDefinition-Replies

  Accepts the following message:

  GetOboTermDefinitionResponse

  Payload

  object

  definition

  object

  xrefs

  array<object>

  databaseName

  string

  databaseId

  string

  description

  string

  definition

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "definition": {
      "xrefs": [
        {
          "databaseName": "string",
          "databaseId": "string",
          "description": "string"
        }
      ],
      "definition": "string"
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.GetOboTermId

  Accepts the following message:

  GetOboTermIdRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.GetOboTermId-Replies

  Accepts the following message:

  GetOboTermIdResponse

  Payload

  object

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  termId

  object

  id

  string

  name

  string

  namespace

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "termId": {
      "id": "string",
      "name": "string",
      "namespace": "string"
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.GetOboTermRelationships

  Accepts the following message:

  GetOboTermRelationshipsRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "owl:Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.GetOboTermRelationships-Replies

  Accepts the following message:

  GetOboTermRelationshipsResponse

  Payload

  object

  relationships

  object

  relationships

  array<object>

  relation

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  value

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "relationships": {
      "relationships": [
        {
          "relation": {
            "type": "OWLObjectPropertyData"
          },
          "value": {
            "type": "OWLClassData"
          }
        }
      ]
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.GetOboTermSynonyms

  Accepts the following message:

  GetOboTermSynonymsRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.GetOboTermSynonyms-Replies

  Accepts the following message:

  GetOboTermSynonymsResponse

  Payload

  object

  synonyms

  array<object>

  xrefs

  array<object>

  databaseName

  string

  databaseId

  string

  description

  string

  name

  string

  scope

  string

  Allowed values:
  • "RELATED"
  • "EXACT"
  • "BROADER"
  • "NARROWER"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "synonyms": [
      {
        "xrefs": [
          {
            "databaseName": "string",
            "databaseId": "string",
            "description": "string"
          }
        ],
        "name": "string",
        "scope": "RELATED"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.GetOboTermXRefs

  Accepts the following message:

  GetOboTermXRefsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.GetOboTermXRefs-Replies

  Accepts the following message:

  GetOboTermXRefsResponse

  Payload

  object

  xRefs

  array<object>

  databaseName

  string

  databaseId

  string

  description

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "xRefs": [
      {
        "databaseName": "string",
        "databaseId": "string",
        "description": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.obo.SetOboTermCrossProduct

  Accepts the following message:

  SetOboTermCrossProductRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Const:"owl:Class"

  Additional properties are NOT allowed.

  crossProduct

  object

  genus

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  relationships

  object

  relationships

  array<object>

  relation

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  value

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "owl:Class"
    },
    "crossProduct": {
      "genus": {
        "type": "OWLClassData"
      },
      "relationships": {
        "relationships": [
          {
            "relation": {
              "type": "OWLObjectPropertyData"
            },
            "value": {
              "type": "OWLClassData"
            }
          }
        ]
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.SetOboTermCrossProduct-Replies

  Accepts the following message:

  SetOboTermCrossProductResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.obo.SetOboTermDefinition

  Accepts the following message:

  SetOboTermDefinitionRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  definition

  object

  xrefs

  array<object>

  databaseName

  string

  databaseId

  string

  description

  string

  definition

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "definition": {
      "xrefs": [
        {
          "databaseName": "string",
          "databaseId": "string",
          "description": "string"
        }
      ],
      "definition": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.SetOboTermDefinition-Replies

  Accepts the following message:

  SetOboTermDefinitionResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.obo.SetOboTermId

  Accepts the following message:

  SetOboTermIdRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  termId

  object

  id

  string

  name

  string

  namespace

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "termId": {
      "id": "string",
      "name": "string",
      "namespace": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.SetOboTermId-Replies

  Accepts the following message:

  SetOboTermIdResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.obo.SetOboTermRelationships

  Accepts the following message:

  SetOboTermRelationshipsRequest

  Payload

  object

  projectId

  string

  format: uuid

  term

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  relationships

  object

  relationships

  array<object>

  relation

  object

  type

  string

  Const:"OWLObjectPropertyData"

  Additional properties are NOT allowed.

  value

  object

  type

  string

  Const:"OWLClassData"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "term": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "relationships": {
      "relationships": [
        {
          "relation": {
            "type": "OWLObjectPropertyData"
          },
          "value": {
            "type": "OWLClassData"
          }
        }
      ]
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.SetOboTermRelationships-Replies

  Accepts the following message:

  SetOboTermRelationshipsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.obo.SetOboTermSynonyms

  Accepts the following message:

  SetOboTermSynonymsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  synonyms

  array<object>

  xrefs

  array<object>

  databaseName

  string

  databaseId

  string

  description

  string

  name

  string

  scope

  string

  Allowed values:
  • "RELATED"
  • "EXACT"
  • "BROADER"
  • "NARROWER"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "synonyms": [
      {
        "xrefs": [
          {
            "databaseName": "string",
            "databaseId": "string",
            "description": "string"
          }
        ],
        "name": "string",
        "scope": "RELATED"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.SetOboTermSynonyms-Replies

  Accepts the following message:

  SetOboTermSynonymsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.obo.SetOboTermXRefs

  Accepts the following message:

  SetOboTermXRefsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  xrefs

  array<object>

  databaseName

  string

  databaseId

  string

  description

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #obo

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "xrefs": [
      {
        "databaseName": "string",
        "databaseId": "string",
        "description": "string"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.obo.SetOboTermXRefs-Replies

  Accepts the following message:

  SetOboTermXRefsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.ontologies.GetOntologyAnnotations

  Accepts the following message:

  GetOntologyAnnotationsRequest

  Payload

  object

  projectId

  string

  format: uuid

  ontologyId

  object | null

  ontologyIRI

  object

  Additional properties are NOT allowed.

  versionIRI

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #ontologies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "ontologyId": {
      "ontologyIRI": {},
      "versionIRI": {}
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.ontologies.GetOntologyAnnotations-Replies

  Accepts the following message:

  GetOntologyAnnotationsResponse

  Payload

  object

  ontologyId

  object

  ontologyIRI

  object

  Additional properties are NOT allowed.

  versionIRI

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  annotations

  array<object>

  type

  string

  Const:"PropertyAnnotationValue"

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "ontologyId": {
      "ontologyIRI": {},
      "versionIRI": {}
    },
    "annotations": [
      {
        "type": "PropertyAnnotationValue"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.ontologies.GetRootOntologyId

  Accepts the following message:

  GetRootOntologyIdRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #ontologies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.ontologies.GetRootOntologyId-Replies

  Accepts the following message:

  GetRootOntologyIdResponse

  Payload

  object

  projectId

  string

  format: uuid

  rootOntologyId

  object

  ontologyIRI

  object

  Additional properties are NOT allowed.

  versionIRI

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "rootOntologyId": {
      "ontologyIRI": {},
      "versionIRI": {}
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.ontologies.MergeOntologies

  Accepts the following message:

  ExistingOntologyMergeAddRequest

  Payload

  object

  projectId

  string

  format: uuid

  documentId

  string

  format: uuid

  selectedOntologies

  array<object>

  ontologyIRI

  object

  Additional properties are NOT allowed.

  versionIRI

  object

  Additional properties are NOT allowed.

  targetOntology

  object

  ontologyIRI

  object

  Additional properties are NOT allowed.

  versionIRI

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #ontologies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
    "selectedOntologies": [
      {
        "ontologyIRI": {},
        "versionIRI": {}
      }
    ],
    "targetOntology": {
      "ontologyIRI": {},
      "versionIRI": {}
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.ontologies.MergeOntologies-Replies

  Accepts the following message:

  ExistingOntologyMergeAddResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.ontologies.SetOntologyAnnotations

  Accepts the following message:

  SetOntologyAnnotationsRequest

  Payload

  object

  projectId

  string

  format: uuid

  ontologyId

  object

  ontologyIRI

  object

  Additional properties are NOT allowed.

  versionIRI

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  fromAnnotations

  array<object>

  type

  string

  Const:"PropertyAnnotationValue"

  toAnnotations

  array<object>

  type

  string

  Const:"PropertyAnnotationValue"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #ontologies

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "ontologyId": {
      "ontologyIRI": {},
      "versionIRI": {}
    },
    "fromAnnotations": [
      {
        "type": "PropertyAnnotationValue"
      }
    ],
    "toAnnotations": [
      {
        "type": "PropertyAnnotationValue"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.ontologies.SetOntologyAnnotations-Replies

  Accepts the following message:

  SetOntologyAnnotationsResponse

  Payload

  object

  ontologyAnnotations

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "ontologyAnnotations": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.perspectives.GetPerspectiveDetails

  Accepts the following message:

  GetPerspectiveDetailsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.GetPerspectiveDetails-Replies

  Accepts the following message:

  GetPerspectiveDetailsResponse

  Payload

  object

  perspectiveDetails

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "perspectiveDetails": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.perspectives.GetPerspectiveLayout

  Accepts the following message:

  GetPerspectiveLayoutRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  perspectiveId

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string",
    "perspectiveId": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.GetPerspectiveLayout-Replies

  Accepts the following message:

  GetPerspectiveLayoutResponse

  Payload

  object

  layout

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "layout": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.perspectives.GetPerspectives

  Accepts the following message:

  GetPerspectivesRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.GetPerspectives-Replies

  Accepts the following message:

  GetPerspectivesResponse

  Payload

  object

  perspectives

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  resettablePerspectives

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "perspectives": [
      {}
    ],
    "resettablePerspectives": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.perspectives.ResetPerspectiveLayout

  Accepts the following message:

  ResetPerspectiveLayoutRequest

  Payload

  object

  projectId

  string

  format: uuid

  perspectiveId

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "perspectiveId": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.ResetPerspectiveLayout-Replies

  Accepts the following message:

  ResetPerspectiveLayoutResponse

  Payload

  object

  resetLayout

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "resetLayout": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.perspectives.ResetPerspectives

  Accepts the following message:

  ResetPerspectivesRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.ResetPerspectives-Replies

  Accepts the following message:

  ResetPerspectivesResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.perspectives.SetPerspectiveDetails

  Accepts the following message:

  SetPerspectiveDetailsRequest

  Payload

  object

  projectId

  string

  format: uuid

  perspectiveDetails

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "perspectiveDetails": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.SetPerspectiveDetails-Replies

  Accepts the following message:

  SetPerspectiveDetailsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.perspectives.SetPerspectiveLayout

  Accepts the following message:

  SetPerspectiveLayoutRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  layout

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string",
    "layout": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.SetPerspectiveLayout-Replies

  Accepts the following message:

  SetPerspectiveLayoutResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.perspectives.SetPerspectives

  Accepts the following message:

  SetPerspectivesRequest

  Payload

  object

  projectId

  string

  format: uuid

  perspectiveIds

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #perspectives

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "perspectiveIds": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.perspectives.SetPerspectives-Replies

  Accepts the following message:

  SetPerspectivesResponse

  Payload

  object

  perspectives

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  resettablePerspectives

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "perspectives": [
      {}
    ],
    "resettablePerspectives": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.ComputeProjectMerge

  Accepts the following message:

  ComputeProjectMergeRequest

  Payload

  object

  projectId

  string

  format: uuid

  projectDocumentId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "projectDocumentId": "42d25621-e870-4bd4-a0ba-db623c2ac48d"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.ComputeProjectMerge-Replies

  Accepts the following message:

  ComputeProjectMergeResponse

  Payload

  object

  diff

  array<object>

  diffOperation

  string

  Allowed values:
  • "ADD"
  • "REMOVE"

  sourceDocument

  string

  lineElement

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "diff": [
      {
        "diffOperation": "ADD",
        "sourceDocument": "string",
        "lineElement": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.CreateNewProject

  Accepts the following message:

  CreateNewProjectRequest

  Payload

  object

  newProjectSettings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "newProjectSettings": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.CreateNewProject-Replies

  Accepts the following message:

  CreateNewProjectResponse

  Payload

  object

  projectDetails

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectDetails": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetAvailableProjects

  Accepts the following message:

  GetAvailableProjectsRequest

  Payload

  object

  Gets the available projects for the authenticated user. An available project is a project that can be opened in WebProtégé.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {}
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetAvailableProjects-Replies

  Accepts the following message:

  GetAvailableProjectsResponse

  Payload

  object

  availableProjects

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "availableProjects": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetAvailableProjectsWithPermission

  Accepts the following message:

  GetAvailableProjectsWithPermissionRequest

  Payload

  object

  permission

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "permission": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetAvailableProjectsWithPermission-Replies

  Accepts the following message:

  GetAvailableProjectsWithPermissionResponse

  Payload

  object

  projectDetails

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectDetails": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetEntityCrudKitSettings

  Accepts the following message:

  GetEntityCrudKitSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetEntityCrudKitSettings-Replies

  Accepts the following message:

  GetEntityCrudKitSettingsResponse

  Payload

  object

  settings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "settings": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetProjectDetails

  Accepts the following message:

  GetProjectDetailsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetProjectDetails-Replies

  Accepts the following message:

  GetProjectDetailsResponse

  Payload

  object

  projectDetails

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectDetails": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetProjectInfo

  Accepts the following message:

  GetProjectInfoRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetProjectInfo-Replies

  Accepts the following message:

  GetProjectInfoResponse

  Payload

  object

  projectSettings

  object

  Additional properties are NOT allowed.

  projectLanguages

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectSettings": {},
    "projectLanguages": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetProjectLangTags

  Accepts the following message:

  GetProjectLangTagsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetProjectLangTags-Replies

  Accepts the following message:

  GetProjectLangTagsResponse

  Payload

  object

  projectId

  string

  format: uuid

  langTags

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "langTags": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetProjectPrefixDeclarations

  Accepts the following message:

  GetProjectPrefixDeclarationsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetProjectPrefixDeclarations-Replies

  Accepts the following message:

  GetProjectPrefixDeclarationsResponse

  Payload

  object

  projectId

  string

  format: uuid

  prefixDeclarations

  array<object>

  prefixName

  string

  prefix

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "prefixDeclarations": [
      {
        "prefixName": "string",
        "prefix": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetProjectSettings

  Accepts the following message:

  GetProjectSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetProjectSettings-Replies

  Accepts the following message:

  GetProjectSettingsResponse

  Payload

  object

  settings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "settings": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.GetProjectSharingSettings

  Accepts the following message:

  GetProjectSharingSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.GetProjectSharingSettings-Replies

  Accepts the following message:

  GetProjectSharingSettingsResponse

  Payload

  object

  settings

  object

  projectId

  string

  format: uuid

  sharingSettings

  array<object>

  personId

  object

  Additional properties are NOT allowed.

  sharingPermission

  string

  Allowed values:
  • "VIEW"
  • "COMMENT"
  • "EDIT"
  • "MANAGE"

  linkSharingPermission

  string

  Allowed values:
  • "VIEW"
  • "COMMENT"
  • "EDIT"
  • "MANAGE"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "settings": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "sharingSettings": [
        {
          "personId": {},
          "sharingPermission": "VIEW"
        }
      ],
      "linkSharingPermission": "VIEW"
    }
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.LoadProject

  Accepts the following message:

  LoadProjectRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.LoadProject-Replies

  Accepts the following message:

  LoadProjectResponse

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  projectDetails

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string",
    "projectDetails": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.MergeUploadedProject

  Accepts the following message:

  MergeUploadedProjectRequest

  Payload

  object

  projectId

  string

  format: uuid

  documentId

  string

  format: uuid

  commitMessage

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052",
    "commitMessage": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.MergeUploadedProject-Replies

  Accepts the following message:

  MergeUploadedProjectResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.projects.MoveProjectToTrash

  Accepts the following message:

  MoveProjectsToTrashRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.MoveProjectToTrash-Replies

  Accepts the following message:

  MoveProjectsToTrashResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.projects.RemoveProjectFromTrash

  Accepts the following message:

  RemoveProjectFromTrashRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.RemoveProjectFromTrash-Replies

  Accepts the following message:

  RemoveProjectFromTrashResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.projects.SetEntityCrudKitSettingsAction

  Accepts the following message:

  SetEntityCrudKitSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  fromSettings

  object

  Additional properties are NOT allowed.

  toSettings

  object

  Additional properties are NOT allowed.

  prefixUpdateStrategy

  string

  Allowed values:
  • "FIND_AND_REPLACE"
  • "LEAVE_INTACT"

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "fromSettings": {},
    "toSettings": {},
    "prefixUpdateStrategy": "FIND_AND_REPLACE"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.SetEntityCrudKitSettingsAction-Replies

  Accepts the following message:

  SetEntityCrudKitSettingsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.projects.SetProjectPrefixDeclarations

  Accepts the following message:

  SetProjectPrefixDeclarationsRequest

  Payload

  object

  projectId

  string

  format: uuid

  prefixDeclarations

  array<object>

  prefixName

  string

  prefix

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "prefixDeclarations": [
      {
        "prefixName": "string",
        "prefix": "string"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.SetProjectPrefixDeclarations-Replies

  Accepts the following message:

  SetProjectPrefixDeclarationsResponse

  Payload

  object

  projectId

  string

  format: uuid

  prefixDeclarations

  array<object>

  prefixName

  string

  prefix

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "prefixDeclarations": [
      {
        "prefixName": "string",
        "prefix": "string"
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.projects.SetProjectSettings

  Accepts the following message:

  SetProjectSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  settings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #projects

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "settings": {}
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.projects.SetProjectSettings-Replies

  Accepts the following message:

  SetProjectSettingsResponse

  Payload

  object

  settings

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "settings": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.search.GetSearchSettings

  Accepts the following message:

  GetSearchSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #search

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.search.GetSearchSettings-Replies

  Accepts the following message:

  GetSearchSettingsResponse

  Payload

  object

  filters

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "filters": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.search.PerformEntitySearch

  Accepts the following message:

  PerformEntitySearchRequest

  Payload

  object

  projectId

  string

  format: uuid

  searchString

  string

  entityTypes

  array<string>

  Items:

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  langTagFilter

  object

  Additional properties are NOT allowed.

  searchFilters

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  pageRequest

  object

  pageNumber

  integer

  pageSize

  integer

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #search

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "searchString": "string",
    "entityTypes": [
      "Class"
    ],
    "langTagFilter": {},
    "searchFilters": [
      {}
    ],
    "pageRequest": {
      "pageNumber": 0,
      "pageSize": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.search.PerformEntitySearch-Replies

  Accepts the following message:

  PerformEntitySearchResponse

  Payload

  object

  searchString

  string

  results

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "searchString": "string",
    "results": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.search.SetSearchSettings

  Accepts the following message:

  SetSearchSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  from

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  to

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #search

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "from": [
      {}
    ],
    "to": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.search.SetSearchSettings-Replies

  Accepts the following message:

  SetSearchSettingsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.sharing.SetProjectSharingSettings

  Accepts the following message:

  SetProjectSharingSettingsRequest

  Payload

  object

  projectId

  string

  format: uuid

  settings

  object

  projectId

  string

  format: uuid

  sharingSettings

  array<object>

  personId

  object

  Additional properties are NOT allowed.

  sharingPermission

  string

  Allowed values:
  • "VIEW"
  • "COMMENT"
  • "EDIT"
  • "MANAGE"

  linkSharingPermission

  string

  Allowed values:
  • "VIEW"
  • "COMMENT"
  • "EDIT"
  • "MANAGE"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #sharing

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "settings": {
      "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
      "sharingSettings": [
        {
          "personId": {},
          "sharingPermission": "VIEW"
        }
      ],
      "linkSharingPermission": "VIEW"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.sharing.SetProjectSharingSettings-Replies

  Accepts the following message:

  SetProjectSharingSettingsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.tags.AddProjectTag

  Accepts the following message:

  AddProjectTagRequest

  Payload

  object

  projectId

  string

  format: uuid

  label

  string

  description

  string

  color

  string

  backgroundColor

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #tags

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "label": "string",
    "description": "string",
    "color": "string",
    "backgroundColor": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.tags.AddProjectTag-Replies

  Accepts the following message:

  AddProjectTagResponse

  Payload

  object

  addedTag

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "addedTag": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.tags.GetEntityTags

  Accepts the following message:

  GetEntityTagsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #tags

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.tags.GetEntityTags-Replies

  Accepts the following message:

  GetEntityTagsResponse

  Payload

  object

  entityTags

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  projectTags

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "entityTags": [
      {}
    ],
    "projectTags": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.tags.GetProjectTags

  Accepts the following message:

  GetProjectTagsRequest

  Payload

  object

  projectId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #tags

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.tags.GetProjectTags-Replies

  Accepts the following message:

  GetProjectTagsResponse

  Payload

  object

  tags

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  tagUsage

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "tags": [
      {}
    ],
    "tagUsage": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.tags.SetProjectTags

  Accepts the following message:

  SetProjectTagsRequest

  Payload

  object

  projectId

  string

  format: uuid

  tagData

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #tags

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "tagData": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.tags.SetProjectTags-Replies

  Accepts the following message:

  SetProjectTagsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.tags.UpdateEntityTags

  Accepts the following message:

  UpdateEntityTagsRequest

  Payload

  object

  projectId

  string

  format: uuid

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  fromTagIds

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  toTagIds

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #tags

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "fromTagIds": [
      {}
    ],
    "toTagIds": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.tags.UpdateEntityTags-Replies

  Accepts the following message:

  UpdateEntityTagsResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.

• PUB webprotege.uploads.GetUploadedOntologies

  Accepts the following message:

  GetUploadedOntologiesRequest

  Payload

  object

  projectId

  string

  format: uuid

  documentId

  string

  format: uuid

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #uploads

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "documentId": "4704590c-004e-410d-adf7-acb7ca0a7052"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.uploads.GetUploadedOntologies-Replies

  Accepts the following message:

  GetUploadedOntologiesResponse

  Payload

  object

  ontologies

  array<object>

  ontologyIRI

  object

  Additional properties are NOT allowed.

  versionIRI

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "ontologies": [
      {
        "ontologyIRI": {},
        "versionIRI": {}
      }
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.users.GetEmailAddress

  Accepts the following message:

  GetEmailAddressRequest

  Payload

  object

  userId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #users

  Examples

  Payload

  {
    "userId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.users.GetEmailAddress-Replies

  Accepts the following message:

  GetEmailAddressResponse

  Payload

  object

  userId

  string

  emailAddress

  string

  format: email

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "userId": "string",
    "emailAddress": "user@example.com"
  }
  

  This example has been generated automatically.

• PUB webprotege.users.GetUserIdCompletions

  Accepts the following message:

  GetUserIdCompletionsRequest

  Payload

  object

  completionText

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #users

  Examples

  Payload

  {
    "completionText": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.users.GetUserIdCompletions-Replies

  Accepts the following message:

  GetUserIdCompletionsResponse

  Payload

  object

  possibleItemCompletions

  array<string>

  Items:

  string

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "possibleItemCompletions": [
      "string"
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.users.SetEmailAddress

  Accepts the following message:

  SetEmailAddressRequest

  Payload

  object

  userId

  string

  emailAddress

  string

  format: email

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that will be echoed in the reply to this message.

  Additional properties are allowed.

  • #users

  Examples

  Payload

  {
    "userId": "string",
    "emailAddress": "user@example.com"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.users.SetEmailAddress-Replies

  Accepts the following message:

  SetEmailAddressResponse

  Examples

• PUB webprotege.watches.GetWatchedEntityChanges

  Accepts the following message:

  GetWatchedEntityChangesRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #watches

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.watches.GetWatchedEntityChanges-Replies

  Accepts the following message:

  GetWatchedEntityChangesResponse

  Payload

  object

  changes

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "changes": {}
  }
  

  This example has been generated automatically.

• PUB webprotege.watches.GetWatches

  Accepts the following message:

  GetWatchesRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #watches

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.watches.GetWatches-Replies

  Accepts the following message:

  GetWatchesResponse

  Payload

  object

  watches

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Examples

  Payload

  {
    "watches": [
      {}
    ]
  }
  

  This example has been generated automatically.

• PUB webprotege.watches.SetEntityWatches

  Accepts the following message:

  SetEntityWatchesRequest

  Payload

  object

  projectId

  string

  format: uuid

  userId

  string

  entity

  object

  iri

  string

  format: iri

  type

  string

  Allowed values:
  • "Class"
  • "ObjectProperty"
  • "DataProperty"
  • "AnnotationProperty"
  • "NamedIndividual"
  • "Datatype"

  Additional properties are NOT allowed.

  watches

  array<object>

  Items:

  object

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Headers

  object

  webprotege_accessToken

  string

  The JSON Web Token (JWT) value that identifies the Principal (the authorized user

  kafka_replyTopic

  string

  The name of the channel that should be used for the reply to this message.

  kafka_correlationId

  string

  The correlation id that identifies the request originator for this message

  Additional properties are allowed.

  • #watches

  Examples

  Payload

  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "userId": "string",
    "entity": {
      "iri": "http://example.com",
      "type": "Class"
    },
    "watches": [
      {}
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "webprotege_accessToken": "string",
    "kafka_replyTopic": "string",
    "kafka_correlationId": "string"
  }
  

  This example has been generated automatically.

• SUB webprotege.watches.SetEntityWatches-Replies

  Accepts the following message:

  SetEntityWatchesResponse

  Payload

  object

  Additional properties are NOT allowed.

  Examples

  Payload

  {}
  

  This example has been generated automatically.