Distributions

get/distributions

List Distributions

Returns a paginated list of all distribution

date_fromstring

Format: date-time

date_tostring

Format: date-time

pageint

Default: 0

sizeint

Default: 50

Responses

Response examples

Successful Response

{
  "items": [
    {
      "name": "string",
      "prod_id": "string",
      "meta": {},
      "type": null,
      "tpp_yaml_id": "string",
      "id": "string",
      "tpp_id": "string",
      "created": "2023-06-07T17:32:28Z",
      "updated": "2023-06-07T17:32:28Z"
    }
  ],
  "total": 123,
  "page": 123,
  "size": 123
}

post/distributions

Create Distribution For Provider Product

Create distribution for each offering.

Must match one of

namestring

required

prod_idstring

metaobject (Meta)

typestring

required

Enum: journey

tpp_yaml_idstring

required

Responses

Request examples

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": "journey",
  "tpp_yaml_id": "string"
}

Response examples

Successful Response

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": null,
  "tpp_yaml_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}

get/distributions/{distribution_id}

Get Distribution

Returns a paginated list of all distribution

distribution_idstring

required

Responses

Response examples

Successful Response

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": null,
  "tpp_yaml_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}

post/distributions/{distribution_id}

Update Distribution For Provider Product

Create distribution for each offering.

Must match one of

namestring

required

prod_idstring

metaobject (Meta)

typestring

required

Enum: journey

tpp_yaml_idstring

required

Responses

Request examples

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": "journey",
  "tpp_yaml_id": "string"
}

Response examples

Successful Response

{
  "name": "string",
  "prod_id": "string",
  "meta": {},
  "type": null,
  "tpp_yaml_id": "string",
  "id": "string",
  "tpp_id": "string",
  "created": "2023-06-07T17:32:28Z",
  "updated": "2023-06-07T17:32:28Z"
}

delete/distributions/{distribution_id}

Delete Distribution

Returns a paginated list of all distribution

pageint

Default: 0

sizeint

Default: 50

Responses

Response examples

Successful Response

Empty response