PANTARIS Data-Events API 2.0.0 documentation

PANTARIS Data-Events API 2.0.0

application/json

The PANTARIS Data Events API keeps you connected to the latest state of resources.

Find more information in our documentation.

Servers

data-events.pantaris.iowssstomp
Access to the data-events based on STOMP on top of WebSockets

Operations

SUB exchange/project.{projectId}/${entityType}.${entityId}.${event}
Entity-Events within the project context. Find more information about entity-events in the documentation.
projectId
required
string
format: uuiduid: projectId
The id of the project

entityType
required
string
uid: entityType
The belonging type of an entity or wildcard (*)

entityId
required
string
format: uuiduid: entityId
The belonging uuid of an entity or wildcard (*)

event
required
string
uid: event
The event or wildcard (*)

Allowed values:
"create"
"update"
"delete"
Accepts the following message:
Entity event in a project contextprojectEvent
Inform about the belonging action within the project context
application/json
object
uid: projectEvent
projectId
string
format: uuid
The id of the project, where the event occurred

entityType
string
The belonging type of an entity

entityId
string
format: uuid
The id of the entity, where the event occurred

event
string
The event which occurred

Allowed values:
"create"
"update"
"delete"
Additional properties are allowed.
Examples
{ "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "entityType": "tasks", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "event": "create" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/${entityType}.${entityId}.${event}
Entity-Events within the application context. Find more information about entity-events in the documentation.
applicationId
required
string
format: uuiduid: applicationId
The id of the application

entityType
required
string
uid: entityType
The belonging type of an entity or wildcard (*)

entityId
required
string
format: uuiduid: entityId
The belonging uuid of an entity or wildcard (*)

event
required
string
uid: event
The event or wildcard (*)

Allowed values:
"create"
"update"
"delete"
Accepts the following message:
Entity event in an application contextapplicationEvent
Inform about the belonging action within the application context
application/json
object
uid: applicationEvent
applicationId
string
format: uuid
The id of the application, where the event occurred

entityType
string
The belonging type of an entity

entityId
string
format: uuid
The id of the entity, where the event occurred

event
string
The event which occurred

Allowed values:
"create"
"update"
"delete"
Additional properties are allowed.
Examples
{ "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "entityType": "tasks", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "event": "create" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.activation.activated
The application was (re-)activated in the belonging runtime-environment

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The product was (re-)activated in a project or organizationproductActivationStateActivated
Inform about a state change
application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project, where the product was state changed

organizationId
string | null
format: uuid
The id of the organization, where the product was state changed

applicationId
string
format: uuid
The id of the application

event
string
Indicates the activated state

Allowed values:
"activated"
"reactivated"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

applicationProvisionRunId
string | null
format: uuid
The application-provisioning-run id. Only given if external provisioning is activated for the application

context
string | null
Indicates the context of the provisioning. Only given if external provisioning is activated for the application

Allowed values:
"production"
"sandbox"
"demo"
subscriptionId
string | null
format: uuid
The application-subscription id, if "context" is set to "production" or "demo". Not given for sandboxes

pricingPlanId
string | null
format: uuid
The application-pricing-plan id, if "context" is set to "production" or "demo". Not given for sandboxes

object
Callbacks for reporting the provisioning states. Only given if external provisioning is activated for the application

object
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "runtimeEnvironment": "PROJECT", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "event": "activated", "projectApplicationId": "4b417119-3dd6-415f-8f9a-b769c0dc61c3", "organizationApplicationId": "eced9cdf-3dcd-4930-9dca-6be374315b39", "sandboxId": "5b4b1d3f-21e4-43f6-8ac1-b460b150f885", "applicationProvisionRunId": "c2ae82aa-bbc0-4ded-84dc-7d9fe5b9541c", "context": "production", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "callbacks": { "updateProgress": { "updateProgress": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/PROVISIONING_IN_PROGRESS?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" }, "finished": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/PROVISIONING_FINISHED?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" }, "failed": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/PROVISIONING_FAILED?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" } } } }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.activation.deactivated
The application was deactivated in the belonging runtime-environment

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The product was deactivated in a project or organizationproductActivationStateDeactivated
Inform about a state change
application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project, where the product was state changed, if the runtimeEnvironment is "PROJECT"

organizationId
string | null
format: uuid
The id of the organization, where the product was state changed, if the runtimeEnvironment is "ORGANIZATION"

applicationId
string
format: uuid
The id of the application

event
string
Indicates the activated state

Allowed values:
"deactivated"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

applicationProvisionRunId
string | null
format: uuid
The application-provisioning-run id. Only given if external provisioning is activated for the application

context
string | null
Indicates the context of the provisioning. Only given if external provisioning is activated for the application

Allowed values:
"production"
"sandbox"
"demo"
subscriptionId
string | null
format: uuid
The application-subscription id, if "context" is set to "production" or "demo". Not given for sandboxes

pricingPlanId
string | null
format: uuid
The application-pricing-plan id, if "context" is set to "production" or "demo". Not given for sandboxes

object
Callbacks for reporting the provisioning states. Only given if external provisioning is activated for the application

object
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "runtimeEnvironment": "PROJECT", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "event": "deactivated", "projectApplicationId": "4b417119-3dd6-415f-8f9a-b769c0dc61c3", "organizationApplicationId": "eced9cdf-3dcd-4930-9dca-6be374315b39", "sandboxId": "5b4b1d3f-21e4-43f6-8ac1-b460b150f885", "applicationProvisionRunId": "c2ae82aa-bbc0-4ded-84dc-7d9fe5b9541c", "context": "production", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "callbacks": { "updateProgress": { "updateProgress": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/PROVISIONING_IN_PROGRESS?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" }, "finished": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/PROVISIONING_FINISHED?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" }, "failed": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/PROVISIONING_FAILED?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" } } } }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.activation.terminated
The application was terminated in the belonging runtime-environment

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The product was terminated in a project or organizationproductActivationStateTerminated
Inform about a state change
application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project, where the product was state changed

organizationId
string | null
format: uuid
The id of the organization, where the product was state changed

applicationId
string
format: uuid
The id of the application

event
string
Indicates the activated state

Allowed values:
"terminated"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

applicationProvisionRunId
string | null
format: uuid
The application-provisioning-run id. Only given if external provisioning is activated for the application

context
string | null
Indicates the context of the provisioning. Only given if external provisioning is activated for the application

Allowed values:
"production"
"sandbox"
"demo"
subscriptionId
string | null
format: uuid
The application-subscription id, if "context" is set to "production" or "demo". Not given for sandboxes

pricingPlanId
string | null
format: uuid
The application-pricing-plan id, if "context" is set to "production" or "demo". Not given for sandboxes

object
Callbacks for reporting the provisioning states. Only given if external provisioning is activated for the application

object
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "runtimeEnvironment": "PROJECT", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "event": "terminated", "projectApplicationId": "4b417119-3dd6-415f-8f9a-b769c0dc61c3", "organizationApplicationId": "eced9cdf-3dcd-4930-9dca-6be374315b39", "sandboxId": "5b4b1d3f-21e4-43f6-8ac1-b460b150f885", "applicationProvisionRunId": "c2ae82aa-bbc0-4ded-84dc-7d9fe5b9541c", "context": "production", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "callbacks": { "updateProgress": { "updateProgress": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/TERMINATION_IN_PROGRESS?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" }, "finished": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/TERMINATION_FINISHED?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" }, "failed": { "url": "https://api.pantaris.io/v2/application-provision-runs/cb603866-ef9b-4010-9e51-19fc814a63ac/status/TERMINATION_FAILED?token=XXY", "method": "POST", "documentation": "https://api.pantaris.io/v2/explorer/#operation/updateApplicationProvisionRunStatus" } } } }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.provisioning.started
The provisioning of product within a runtime-environment has started

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The provisioning state of a product in a project or organizationproductProvisioningState
Inform about a state change
application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project

organizationId
string | null
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

event
string
Indicates the provisioning state

Allowed values:
"started"
"finished"
"stopped"
"failed"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

entityId
string | null
format: uuid
The id of an entity (for example an instance id)

Additional properties are allowed.
Examples
{ "runtimeEnvironment": "PROJECT", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "event": "started", "projectApplicationId": "4b417119-3dd6-415f-8f9a-b769c0dc61c3", "organizationApplicationId": "eced9cdf-3dcd-4930-9dca-6be374315b39", "sandboxId": "5b4b1d3f-21e4-43f6-8ac1-b460b150f885", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.provisioning.finished
The provisioning of product within a belonging runtime-environment has finished

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The provisioning state of a product in a project or organizationproductProvisioningState
Inform about a state change
application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project

organizationId
string | null
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

event
string
Indicates the provisioning state

Allowed values:
"started"
"finished"
"stopped"
"failed"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

entityId
string | null
format: uuid
The id of an entity (for example an instance id)

Additional properties are allowed.
Examples
{ "runtimeEnvironment": "PROJECT", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "event": "started", "projectApplicationId": "4b417119-3dd6-415f-8f9a-b769c0dc61c3", "organizationApplicationId": "eced9cdf-3dcd-4930-9dca-6be374315b39", "sandboxId": "5b4b1d3f-21e4-43f6-8ac1-b460b150f885", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.provisioning.failed
The provisioning of product within a belonging runtime-environment run into an error

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The provisioning state of a product in a project or organizationproductProvisioningState
Inform about a state change
application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project

organizationId
string | null
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

event
string
Indicates the provisioning state

Allowed values:
"started"
"finished"
"stopped"
"failed"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

entityId
string | null
format: uuid
The id of an entity (for example an instance id)

Additional properties are allowed.
Examples
{ "runtimeEnvironment": "PROJECT", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "event": "started", "projectApplicationId": "4b417119-3dd6-415f-8f9a-b769c0dc61c3", "organizationApplicationId": "eced9cdf-3dcd-4930-9dca-6be374315b39", "sandboxId": "5b4b1d3f-21e4-43f6-8ac1-b460b150f885", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.subscription.created
A subscription for the product was created

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The subscription state of product in an organizationsubscriptionState
Inform about a state change
application/json
object
organizationId
string
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

subscriptionId
string
format: uuid
The id of the application-subscription

pricingPlanId
string
format: uuid
The id of the application-pricing-plan

event
string
Indicates the subscription state

Allowed values:
"created"
"active"
"inactive"
"suspended"
"terminated"
Additional properties are allowed.
Examples
{ "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "event": "created" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.subscription.active
A subscription for the product is now active

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The subscription state of product in an organizationsubscriptionState
Inform about a state change
application/json
object
organizationId
string
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

subscriptionId
string
format: uuid
The id of the application-subscription

pricingPlanId
string
format: uuid
The id of the application-pricing-plan

event
string
Indicates the subscription state

Allowed values:
"created"
"active"
"inactive"
"suspended"
"terminated"
Additional properties are allowed.
Examples
{ "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "event": "created" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.subscription.inactive
A subscription for the product is now inactive

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The subscription state of product in an organizationsubscriptionState
Inform about a state change
application/json
object
organizationId
string
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

subscriptionId
string
format: uuid
The id of the application-subscription

pricingPlanId
string
format: uuid
The id of the application-pricing-plan

event
string
Indicates the subscription state

Allowed values:
"created"
"active"
"inactive"
"suspended"
"terminated"
Additional properties are allowed.
Examples
{ "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "event": "created" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.subscription.suspended
A subscription for the product is now suspended (coming soon. Not supported yet)

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The subscription state of product in an organizationsubscriptionState
Inform about a state change
application/json
object
organizationId
string
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

subscriptionId
string
format: uuid
The id of the application-subscription

pricingPlanId
string
format: uuid
The id of the application-pricing-plan

event
string
Indicates the subscription state

Allowed values:
"created"
"active"
"inactive"
"suspended"
"terminated"
Additional properties are allowed.
Examples
{ "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "event": "created" }

This example has been generated automatically.
SUB exchange/application.{applicationId}/product.subscription.terminated
A subscription for the product is now terminated

applicationId
required
string
format: uuiduid: applicationId
The id of the application
Accepts the following message:
The subscription state of product in an organizationsubscriptionState
Inform about a state change
application/json
object
organizationId
string
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

subscriptionId
string
format: uuid
The id of the application-subscription

pricingPlanId
string
format: uuid
The id of the application-pricing-plan

event
string
Indicates the subscription state

Allowed values:
"created"
"active"
"inactive"
"suspended"
"terminated"
Additional properties are allowed.
Examples
{ "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5", "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f", "pricingPlanId": "c93726f9-189f-4fc5-bad5-9d1f51ff93e2", "event": "created" }

This example has been generated automatically.

Messages

#1Entity event in a project contextprojectEvent
Inform about the belonging action within the project context
- application/json
object
uid: projectEvent
projectId
string
format: uuid
The id of the project, where the event occurred

entityType
string
The belonging type of an entity

entityId
string
format: uuid
The id of the entity, where the event occurred

event
string
The event which occurred

Allowed values:
"create"
"update"
"delete"
Additional properties are allowed.
#2Entity event in an application contextapplicationEvent
Inform about the belonging action within the application context
- application/json
object
uid: applicationEvent
applicationId
string
format: uuid
The id of the application, where the event occurred

entityType
string
The belonging type of an entity

entityId
string
format: uuid
The id of the entity, where the event occurred

event
string
The event which occurred

Allowed values:
"create"
"update"
"delete"
Additional properties are allowed.
#3The product was (re-)activated in a project or organizationproductActivationStateActivated
Inform about a state change
- application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project, where the product was state changed

organizationId
string | null
format: uuid
The id of the organization, where the product was state changed

applicationId
string
format: uuid
The id of the application

event
string
Indicates the activated state

Allowed values:
"activated"
"reactivated"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

applicationProvisionRunId
string | null
format: uuid
The application-provisioning-run id. Only given if external provisioning is activated for the application

context
string | null
Indicates the context of the provisioning. Only given if external provisioning is activated for the application

Allowed values:
"production"
"sandbox"
"demo"
subscriptionId
string | null
format: uuid
The application-subscription id, if "context" is set to "production" or "demo". Not given for sandboxes

pricingPlanId
string | null
format: uuid
The application-pricing-plan id, if "context" is set to "production" or "demo". Not given for sandboxes

object
Callbacks for reporting the provisioning states. Only given if external provisioning is activated for the application

object
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#4The product was deactivated in a project or organizationproductActivationStateDeactivated
Inform about a state change
- application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project, where the product was state changed, if the runtimeEnvironment is "PROJECT"

organizationId
string | null
format: uuid
The id of the organization, where the product was state changed, if the runtimeEnvironment is "ORGANIZATION"

applicationId
string
format: uuid
The id of the application

event
string
Indicates the activated state

Allowed values:
"deactivated"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

applicationProvisionRunId
string | null
format: uuid
The application-provisioning-run id. Only given if external provisioning is activated for the application

context
string | null
Indicates the context of the provisioning. Only given if external provisioning is activated for the application

Allowed values:
"production"
"sandbox"
"demo"
subscriptionId
string | null
format: uuid
The application-subscription id, if "context" is set to "production" or "demo". Not given for sandboxes

pricingPlanId
string | null
format: uuid
The application-pricing-plan id, if "context" is set to "production" or "demo". Not given for sandboxes

object
Callbacks for reporting the provisioning states. Only given if external provisioning is activated for the application

object
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#5The product was terminated in a project or organizationproductActivationStateTerminated
Inform about a state change
- application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project, where the product was state changed

organizationId
string | null
format: uuid
The id of the organization, where the product was state changed

applicationId
string
format: uuid
The id of the application

event
string
Indicates the activated state

Allowed values:
"terminated"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

applicationProvisionRunId
string | null
format: uuid
The application-provisioning-run id. Only given if external provisioning is activated for the application

context
string | null
Indicates the context of the provisioning. Only given if external provisioning is activated for the application

Allowed values:
"production"
"sandbox"
"demo"
subscriptionId
string | null
format: uuid
The application-subscription id, if "context" is set to "production" or "demo". Not given for sandboxes

pricingPlanId
string | null
format: uuid
The application-pricing-plan id, if "context" is set to "production" or "demo". Not given for sandboxes

object
Callbacks for reporting the provisioning states. Only given if external provisioning is activated for the application

object
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
object
url
string
format: uri
method
string
documentation
string
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
#6The provisioning state of a product in a project or organizationproductProvisioningState
Inform about a state change
- application/json
object
runtimeEnvironment
string
Indicates the runtime environment. When set to "PROJECT", "projectId" and "projectApplicationId" is set. When set to "ORGANIZATION", "organizationId" and "organizationApplicationId" is set. If "context" is set to "sandbox", the "sandboxId" is present instead of "projectApplicationId"/"organizationApplicationId"

Allowed values:
"PROJECT"
"ORGANIZATION"
projectId
string | null
format: uuid
The id of the project

organizationId
string | null
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

event
string
Indicates the provisioning state

Allowed values:
"started"
"finished"
"stopped"
"failed"
projectApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "PROJECT" and the context is not "sandbox"

organizationApplicationId
string | null
format: uuid
The relation id, if the runtimeEnvironment is "ORGANIZATION" and the context is not "sandbox"

sandboxId
string | null
format: uuid
The sandbox id, if "context" is set to "sandbox"

entityId
string | null
format: uuid
The id of an entity (for example an instance id)

Additional properties are allowed.
#7The subscription state of product in an organizationsubscriptionState
Inform about a state change
- application/json
object
organizationId
string
format: uuid
The id of the organization

applicationId
string
format: uuid
The id of the application

subscriptionId
string
format: uuid
The id of the application-subscription

pricingPlanId
string
format: uuid
The id of the application-pricing-plan

event
string
Indicates the subscription state

Allowed values:
"created"
"active"
"inactive"
"suspended"
"terminated"
Additional properties are allowed.

Schemas

object
uid: projectEvent
projectId
string
format: uuid
The id of the project, where the event occurred

entityType
string
The belonging type of an entity

entityId
string
format: uuid
The id of the entity, where the event occurred

event
string
The event which occurred

Allowed values:
"create"
"update"
"delete"
Additional properties are allowed.
object
uid: applicationEvent
applicationId
string
format: uuid
The id of the application, where the event occurred

entityType
string
The belonging type of an entity

entityId
string
format: uuid
The id of the entity, where the event occurred

event
string
The event which occurred

Allowed values:
"create"
"update"
"delete"
Additional properties are allowed.

PANTARIS Data-Events API 2.0.0

Servers

Operations

SUB exchange/project.{projectId}/${entityType}.${entityId}.${event}

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/${entityType}.${entityId}.${event}

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.activation.activated

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.activation.deactivated

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.activation.terminated

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.provisioning.started

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.provisioning.finished

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.provisioning.failed

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.subscription.created

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.subscription.active

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.subscription.inactive

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.subscription.suspended

Examples

This example has been generated automatically.

SUB exchange/application.{applicationId}/product.subscription.terminated

Examples

This example has been generated automatically.

Messages

Schemas