Publish Marketplace Listing

Publish a workflow definition to the marketplace.

POST/api/v1/workflows/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/workflows/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: PUBLISH_MARKETPLACE_LISTING" \
  -H "Content-Type: application/json" \
  -d '{
    "allowed_regions": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "currency_code": "USD",
    "definition_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "description_key": "string",
    "license": "APACHE2",
    "price_cents": 125000,
    "published_by": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "publisher_identity": "string",
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "title_key": "string",
    "version": {
      "major": 1,
      "minor": 125000,
      "patch": 1
    },
    "visibility": "PRIVATE"
  }'

Authorization

Minimum role: Tenant administratorThe caller must hold this role or a higher one.
Action: PUBLISH_MARKETPLACE_LISTING

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be PUBLISH_MARKETPLACE_LISTING for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

allowed_regionsarray of stringRequired
No description yet.
categoriesarray of stringRequired
No description yet.
currency_codestringRequired
No description yet.
definition_iduuidRequired
No description yet.
description_keystringRequired
No description yet.
licenseenumRequired
MarketplaceListing.license — SPDX-aligned + commercial.
Allowed values
- APACHE2
- MIT
- BSD3_CLAUSE
- GPL3
- PROPRIETARY
- COMMERCIAL
- INTERNAL_ONLY
price_centsintegerRequired
No description yet.
published_byuuidRequired
No description yet.
publisher_identitystringRequired
No description yet.
tenant_iduuidRequired
No description yet.
title_keystringRequired
No description yet.
minimum length 1
maximum length 200
versionobjectRequired
No description yet.
3 child fields
- majorintegerRequired
  No description yet.
  at least 0
- minorintegerRequired
  No description yet.
  at least 0
- patchintegerRequired
  No description yet.
  at least 0
visibilityenumRequired
MarketplaceListing.visibility.
Allowed values
- PRIVATE
- UNLISTED
- PUBLIC
- PARTNER_ONLY

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send PUBLISH_MARKETPLACE_LISTING.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below tenantadmin or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.