openapi: 3.0.3
info:
description: "[CloudBlue Connect](https://connect.cloudblue.com)\nis a cloud end-to-end\
\ supply automation platform that joins service vendor and service provider efforts\n\
to reach their business goals most effectively and efficiently. For this purpose,\
\ it provides a highly\ncustomizable service to arrange various integrated business\
\ flows, including contract management, product\ninformation flow, ordering and\
\ fulfillment, subscription management, and resource usage reporting.\n\nConnect\
\ REST API provides you with the lowest-level access to the functionality of the\
\ Connect Platform.\nAll other integration methods, like our Portals, [SDKs](https://connect.cloudblue.com/community/sdk/)\n\
and [Extensions](https://connect.cloudblue.com/community/extensions/) are built\
\ on top of the REST API layer.\n\nPlease visit our [Community Portal](https://connect.cloudblue.com/community)\
\ for more information.\n\n\n\n> \u26A0 This file was generated on Tue Jan 7\
\ 16:53:50 2025 (UTC) and may not be updated.\nPlease download the latest version\
\ at\n[https://apispec.connect.cloudblue.com/connect-openapi30.yml](https://apispec.connect.cloudblue.com/connect-openapi30.yml]).\n"
title: CloudBlue Connect API
version: '34.0'
servers:
- url: https://api.connect.cloudblue.com/public/v1
security:
- Apikey0: []
paths:
/subscriptions/assets:
get:
operationId: subscriptions_assets_list_listSubscriptions
description: ''
tags:
- Subscriptions
parameters:
- $ref: '#/components/parameters/subscriptions.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/subscriptions.RQLContentRangeLimitOffsetPagination.offset'
- name: billing.next_date
description: 'Filter for: billing.next_date
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: billing.period.uom
description: 'Filter for: billing.period.uom
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- monthly
- yearly
- years_2
- years_3
- years_4
- years_5
- years_6
- name: connection.hub.id
description: 'Filter for: connection.hub.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.hub.name
description: 'Filter for: connection.hub.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.id
description: 'Filter for: connection.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.provider.id
description: 'Filter for: connection.provider.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.provider.name
description: 'Filter for: connection.provider.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.type
description: 'Filter for: connection.type
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- preview
- name: connection.vendor.id
description: 'Filter for: connection.vendor.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.vendor.name
description: 'Filter for: connection.vendor.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: external_uid
description: 'Filter for: external_uid
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: items
description: 'Filter for: items
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** MP-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.id
description: 'Filter for: params.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.name
description: 'Filter for: params.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.value
description: 'Filter for: params.value
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request
description: "This filter is used for explicit select. For example, select(pending_request).\
\ If you need to treat pending_request data in your application for assets,\
\ please consider adding this select(pending_request) into your request.\n\
\n**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request.template
description: "This filter is used for explicit select. For example, select(pending_request.template).\
\ If you need to treat pending_request.template data in your application\
\ for assets, please consider adding this select(pending_request.template)\
\ into your request.\n\n**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- processing
- active
- terminating
- suspended
- terminated
- name: template
description: "This filter is used for explicit select. For example, select(template).\
\ If you need to treat template.id or template.name data in your application\
\ for assets, please consider adding this select(template) into your request.\n\
\n**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.customer.id
description: 'Filter for: tiers.customer.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.customer.name
description: 'Filter for: tiers.customer.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.tier1.id
description: 'Filter for: tiers.tier1.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.tier2.id
description: 'Filter for: tiers.tier2.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/subscriptions.Subscriptions'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/subscriptions.any_400'
/subscriptions/assets/{id}:
get:
operationId: subscriptions_assets_detail_retrieveSubscription
description: ''
tags:
- Subscriptions
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Subscription.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptions.Subscription'
description: ''
'400':
$ref: '#/components/responses/subscriptions.any_400'
/subscriptions/requests:
get:
operationId: subscriptions_requests_list_listBillingRequests
description: ''
tags:
- Subscriptions
parameters:
- $ref: '#/components/parameters/subscriptions.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/subscriptions.RQLContentRangeLimitOffsetPagination.offset'
- name: asset.billing.next_date
description: 'Filter for: asset.billing.next_date
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: asset.billing.period.uom
description: 'Filter for: asset.billing.period.uom
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- monthly
- yearly
- years_2
- years_3
- years_4
- years_5
- years_6
- name: asset.connection.hub.id
description: 'Filter for: asset.connection.hub.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.hub.name
description: 'Filter for: asset.connection.hub.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.id
description: 'Filter for: asset.connection.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.provider.id
description: 'Filter for: asset.connection.provider.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.provider.name
description: 'Filter for: asset.connection.provider.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.type
description: 'Filter for: asset.connection.type
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- preview
- name: asset.connection.vendor.id
description: 'Filter for: asset.connection.vendor.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.vendor.name
description: 'Filter for: asset.connection.vendor.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.contract.id
description: 'Filter for: asset.contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.external_id
description: 'Filter for: asset.external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.external_uid
description: 'Filter for: asset.external_uid
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.id
description: 'Filter for: asset.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.marketplace.id
description: 'Filter for: asset.marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** MP-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.marketplace.name
description: 'Filter for: asset.marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.params.name
description: 'Filter for: asset.params.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.params.value
description: 'Filter for: asset.params.value
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.product.id
description: 'Filter for: asset.product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.product.name
description: 'Filter for: asset.product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.customer.id
description: 'Filter for: asset.tiers.customer.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.customer.name
description: 'Filter for: asset.tiers.customer.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.tier1.id
description: 'Filter for: asset.tiers.tier1.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.tier2.id
description: 'Filter for: asset.tiers.tier2.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: period.from
description: 'Filter for: period.from
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: period.to
description: 'Filter for: period.to
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: period.uom
description: 'Filter for: period.uom
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- monthly
- yearly
- years_2
- years_3
- years_4
- years_5
- years_6
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- vendor
- provider
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/subscriptions.BillingRequest'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/subscriptions.any_400'
post:
operationId: subscriptions_requests_list_createBillingRequest
description: ''
tags:
- Subscriptions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptions.NewBillingRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptions.BillingRequest'
description: ''
'400':
$ref: '#/components/responses/subscriptions.any_400'
/subscriptions/requests/{id}:
get:
operationId: subscriptions_requests_detail_retrieveBillingRequest
description: ''
tags:
- Subscriptions
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptions.BillingRequest'
description: ''
'400':
$ref: '#/components/responses/subscriptions.any_400'
/subscriptions/requests/{id}/attributes:
put:
operationId: subscriptions_requests_attributes_putAttributesBillingRequest
description: ''
tags:
- Subscriptions
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Request.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptions.Attribute'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/subscriptions.Attribute'
description: ''
'400':
$ref: '#/components/responses/subscriptions.any_400'
/agreements:
get:
operationId: dp_agreement_list_listAgreements
description: ''
tags:
- Agreements
parameters:
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: active
description: 'Filter for: active
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: created
description: 'Filter for: created
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: forms.id
description: 'Filter for: forms.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: forms__type
description: 'Filter for: forms__type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- enroll
- product
- item
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__id
description: 'Filter for: marketplace__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__name
description: 'Filter for: marketplace__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.id
description: 'Filter for: owner.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.name
description: 'Filter for: owner.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner__id
description: 'Filter for: owner__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner__name
description: 'Filter for: owner__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: title
description: 'Filter for: title
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- distribution
- program
- service
- syndication
- referral
- name: updated
description: 'Filter for: updated
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Agreement'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_agreement_list_createAgreement
description: ''
tags:
- Agreements
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
enum:
- distribution
- program
- service
- sourcing
- product
title:
type: string
description:
type: string
sourcing:
type: object
properties:
type:
type: string
document_type:
type: string
enum:
- external
- upload
link:
type: string
format: uri
file:
type: string
format: binary
active:
type: boolean
oneOf:
- required:
- title
- description
- document_type
- link
- required:
- title
- description
- document_type
- file
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Agreement'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/agreements/{agreement_id}/agreements:
get:
operationId: dp_agreement_agreements_list_listAgreements
description: Marketplace (Distribution) Agreements.
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: auto_accept
description: 'Filter for: auto_accept
**lookups:** eq, ne
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Agreement'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_agreement_agreements_list_createAgreement
description: Marketplace (Distribution) Agreements.
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Agreement'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Agreement'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/agreements/{agreement_id}/contracts:
get:
operationId: dp_agreement_contracts_list_listContracts
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Contract'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_agreement_contracts_list_createContract
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Contract'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Contract'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/agreements/{agreement_id}/marketplaces:
get:
operationId: dp_agreement_marketplaces_list_listMarketplaceExtendedReferences
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: countries.id
description: 'Filter for: countries.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: countries.name
description: 'Filter for: countries.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: currency
description: 'Filter for: currency
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UYW
- UZS
- VED
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.contracts
description: 'Filter for: stats.contracts
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.hubs
description: 'Filter for: stats.hubs
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.MarketplaceExtendedReference'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_agreement_marketplaces_list_createMarketplaceExtendedReference
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.MarketplaceExtendedReference'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.MarketplaceExtendedReference'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/agreements/{agreement_id}/marketplaces/{id}:
delete:
operationId: dp_agreement_marketplaces_detail_destroyMarketplaceExtendedReference
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/agreements/{agreement_id}/partners:
get:
operationId: dp_agreement_partners_list_listContracts
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: agreement.id
description: 'Filter for: agreement.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.name
description: 'Filter for: agreement.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.status
description: 'Filter for: contract.status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- new
- enrolling
- pending
- active
- terminated
- rejected
- name: contract.version
description: 'Filter for: contract.version
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: events.countersigned.at
description: 'Filter for: events.countersigned.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.countersigned.by.id
description: 'Filter for: events.countersigned.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.signed.at
description: 'Filter for: events.signed.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.signed.by.id
description: 'Filter for: events.signed.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: role
description: 'Filter for: role
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- vendor
- distributor
- reseller
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.PartnerReference'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/agreements/{agreement_id}/product-groups:
get:
operationId: dp_agreement_product_groups_list_listProductGroups
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.by.id
description: 'Filter for: events.updated.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.by.name
description: 'Filter for: events.updated.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.agreements
description: 'Filter for: stats.agreements
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.contracts
description: 'Filter for: stats.contracts
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.products
description: 'Filter for: stats.products
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductGroupReference'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_agreement_product_groups_list_createProductGroup
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductGroupReference'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductGroupReference'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/agreements/{agreement_id}/product-groups/{id}:
delete:
operationId: dp_agreement_product_groups_detail_destroyProductGroup
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Product Group.
schema:
type: string
responses:
'204':
description: ''
/agreements/{agreement_id}/products:
get:
operationId: dp_agreement_products_list_listProducts
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: category.id
description: 'Filter for: category.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: category.name
description: 'Filter for: category.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Product'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/agreements/{agreement_id}/products/{product_id}/marketplaces:
get:
operationId: dp_agreement_products_marketplaces_list_listMarketplaces
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- name: product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: countries.id
description: 'Filter for: countries.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: countries.name
description: 'Filter for: countries.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: currency
description: 'Filter for: currency
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UYW
- UZS
- VED
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.contracts
description: 'Filter for: stats.contracts
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.hubs
description: 'Filter for: stats.hubs
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.MarketplaceReference'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/agreements/{agreement_id}/versions:
get:
operationId: dp_agreement_versions_list_listAgreementVersions
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.AgreementVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_agreement_versions_list_createAgreementVersion
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementVersionCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementVersion'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/agreements/{agreement_id}/versions/{version}:
get:
operationId: dp_agreement_versions_detail_retrieveAgreementVersion
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementVersion'
description: ''
delete:
operationId: dp_agreement_versions_detail_destroyAgreementVersion
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/agreements/{agreement_id}/versions/{version}/activate:
post:
operationId: dp_agreement_versions_activate_postActivateAgreementVersion
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
description: ''
/agreements/{agreement_id}/versions/{version}/document:
get:
operationId: dp_agreement_versions_document_getDocumentAgreementVersion
description: ''
tags:
- Agreements
parameters:
- name: agreement_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'302':
description: ''
/agreements/{id}:
get:
operationId: dp_agreement_detail_retrieveAgreement
description: Get base object or redirect to object version.
tags:
- Agreements
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Agreement.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Agreement'
description: ''
put:
operationId: dp_agreement_detail_updateAgreement
description: ''
tags:
- Agreements
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Agreement.
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_agreement_detail_destroyAgreement
description: ''
tags:
- Agreements
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Agreement.
schema:
type: string
responses:
'204':
description: ''
/agreements/{id}/document:
get:
operationId: dp_agreement_document_getDocumentAgreement
description: ''
tags:
- Agreements
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Agreement.
schema:
type: string
responses:
'302':
description: ''
/assets:
get:
operationId: dp_asset_list_listSubscriptions
description: 'Subscription endpoints allows the listing of Subscription objects
and rendering
the Control Panel template.'
tags:
- Assets
parameters:
- $ref: '#/components/parameters/dp.MySQLandRQL1000Pagination.limit'
- $ref: '#/components/parameters/dp.MySQLandRQL1000Pagination.offset'
- name: configuration
description: 'This filter is used for explicit negative select. For example,
select(-configuration). It will not return "configuration" object in the
response. Please consider using this negative select if in your application
you do not need to treat "configuration" object, it may dramatically increase
/assets API performance.
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.hub.id
description: 'Filter for: connection.hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** HB-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.hub.name
description: 'Filter for: connection.hub.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.id
description: 'Filter for: connection.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CT-0000-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.provider.id
description: 'Filter for: connection.provider.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.provider.name
description: 'Filter for: connection.provider.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.type
description: 'Filter for: connection.type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: connection.vendor.id
description: 'Filter for: connection.vendor.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.vendor.name
description: 'Filter for: connection.vendor.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: created
description: 'Filter for: created
**lookups:** gt, lt
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: external_uid
description: 'Filter for: external_uid
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.id
description: 'Filter for: hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** HB-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.name
description: 'Filter for: hub.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: items
description: 'This filter is used for explicit negative select. For example,
select(-items). It will not return "items" list in the response. Please
consider using this negative select if in your application you do not need
to treat "items" list, it may dramatically increase /assets API performance.
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true
**null:** MP-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.id
description: 'Filter for: params.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.value
description: 'Filter for: params.value
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request
description: "This filter is used for explicit select. For example, select(pending_request)\
\ will include the \"pending_request\" object in the response. For performance\
\ reasons, use select(pending_request) only if you need this object.\n\n\
**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request.template
description: "This filter is used for explicit select. For example, select(pending_request.template)\
\ will include the \"pending_request\" object in the response, which in\
\ turn will include the \"template\" object. For performance reasons, use\
\ select(pending_request.template) only if you need this object.\n\n**lookups:**\
\ \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.title
description: 'Filter for: product.title
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- processing
- active
- terminating
- suspended
- terminated
- name: template
description: "This filter is used for explicit select. For example, select(template).\
\ If you need to treat template.id or template.name data in your application\
\ for assets, please consider adding this select(template) into your request.\n\
\n**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: template.id
description: 'Filter for: template.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.customer.external_id
description: 'Filter for: tiers.customer.external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.customer.external_uid
description: 'Filter for: tiers.customer.external_uid
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.customer.id
description: 'Filter for: tiers.customer.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.customer.name
description: 'Filter for: tiers.customer.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.tier1.id
description: 'Filter for: tiers.tier1.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers.tier2.id
description: 'Filter for: tiers.tier2.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: updated
description: 'Filter for: updated
**lookups:** gt, lt
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Subscription'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/assets/{asset_id}/requests:
get:
operationId: dp_asset_requests_list_listSubscriptions
description: ''
tags:
- Assets
parameters:
- name: asset_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQL1000Pagination.limit'
- $ref: '#/components/parameters/dp.RQL1000Pagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.RequestReference'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/assets/{id}:
get:
operationId: dp_asset_detail_retrieveSubscription
description: obtains a concrete asset identified by it's id
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this subscription.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Subscription'
description: ''
/assets/{id}/render:
get:
operationId: dp_asset_render_getRenderSubscription
description: Render linked template to the asset using the parameters from the
asset
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this subscription.
schema:
type: string
- name: Connect-Localization
in: header
description: 'This is an **optional** header. Providing this header will allow
you to receive localized result of this API. The system will fetch available
template translations from localization service under your account and will
provide translated rendered template. **Accepted values**: `AF, AR, AR-DZ,
AST, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, DSB, EL, EN, EN-AU, EN-GB,
EO, ES, ES-AR, ES-CO, ES-MX, ES-NI, ES-VE, ET, EU, FA, FI, FR, FY, GA, GD,
GL, HE, HI, HR, HSB, HU, HY, IA, ID, IG, IO, IS, IT, JA, KA, KAB, KK, KM,
KN, KO, KY, LB, LT, LV, MK, ML, MN, MR, MY, NB, NE, NL, NN, NO, OS, PA,
PL, PT, PT-BR, RO, RU, SK, SL, SQ, SR, SR-LATN, SV, SW, TA, TE, TG, TH,
TK, TR, TT, UDM, UK, UR, UZ, VI, ZH-CN, ZH-HANS, ZH-HANT, ZH-HK, ZH-MO,
ZH-MY, ZH-SG, ZH-TW.` As an alternative, you can also provide in this header
the exact translation id you would like to use, i.e. `TRN-1234-5678-9101`.
Such translation must exist under your account in localization service,
it may or may not be active.'
schema:
$ref: '#/components/headers/Connect-Localization'
responses:
'200':
description: ''
content:
text/markdown:
schema:
type: string
example: '
# Sample Activation Template
Activation template is used to share details of the **successful**
subscription creation with
the user. Once purchase request is approved, this template is used
to
generate user-visible notification.
This template uses **[Markdown](https://en.wikipedia.org/wiki/Markdown)**
syntax and allows
to use Parameters of the product which has scope ''Subscription''.
### Formatting
Markdown allows you to control various aspects of the document:
1. Text formatting like **bold** or *italic*
2. Images embedding
3. Lists
4. and more
### Parameters
You can refer to the Parameters using their ID, like in the following
example:
* The value of **Title of the Parameter A** is **PARAMETER A VALUE**
* The value of **Title of the Parameter B** is **PARAMETER B VALUE**
You can also embed pictures like the one below:

'
headers:
Connect-Localization:
description: This is an **optional** header. Locale id of the returned
data according to Connect Localization service configuration under
your account.
schema:
type: string
/catalog/groups:
get:
operationId: dp_catalog_groups_list_listProductGroups
description: '# Create and manage Product Groups.'
tags:
- Catalog
parameters:
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.by.id
description: 'Filter for: events.updated.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.by.name
description: 'Filter for: events.updated.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.agreements
description: 'Filter for: stats.agreements
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.contracts
description: 'Filter for: stats.contracts
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.products
description: 'Filter for: stats.products
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductGroup'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_catalog_groups_list_createProductGroup
description: '# Create and manage Product Groups.'
tags:
- Catalog
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description:
type: string
products:
type: array
items:
type: object
properties:
id:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductGroup'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/catalog/groups/{id}:
get:
operationId: dp_catalog_groups_detail_retrieveProductGroup
description: '# Create and manage Product Groups.'
tags:
- Catalog
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Product Group.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductGroup'
description: ''
put:
operationId: dp_catalog_groups_detail_updateProductGroup
description: '# Create and manage Product Groups.'
tags:
- Catalog
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Product Group.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description:
type: string
products:
type: array
items:
type: object
properties:
id:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductGroup'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_catalog_groups_detail_destroyProductGroup
description: '# Create and manage Product Groups.'
tags:
- Catalog
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Product Group.
schema:
type: string
responses:
'204':
description: ''
/catalog/groups/{product_group_id}/agreements:
get:
operationId: dp_catalog_group_agreements_list_listAgreements
description: '# Collection of Product Group Agreements.'
tags:
- Catalog
parameters:
- name: product_group_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.AgreementReferenceWithDescription'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/catalog/groups/{product_group_id}/partners:
get:
operationId: dp_catalog_group_partners_list_listContracts
description: '# Collection of Product Group Partners.'
tags:
- Catalog
parameters:
- name: product_group_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: agreement.id
description: 'Filter for: agreement.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.name
description: 'Filter for: agreement.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.status
description: 'Filter for: contract.status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- new
- enrolling
- pending
- active
- terminated
- rejected
- name: contract.version
description: 'Filter for: contract.version
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: events.countersigned.at
description: 'Filter for: events.countersigned.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.countersigned.by.id
description: 'Filter for: events.countersigned.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.signed.at
description: 'Filter for: events.signed.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.signed.by.id
description: 'Filter for: events.signed.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: role
description: 'Filter for: role
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- vendor
- distributor
- reseller
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.PartnerReference'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/catalog/groups/{product_group_id}/products:
get:
operationId: dp_catalog_group_products_list_listProducts
description: '# Collection of Product Group Products.'
tags:
- Catalog
parameters:
- name: product_group_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: category.id
description: 'Filter for: category.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: category.name
description: 'Filter for: category.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Product'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_catalog_group_products_list_createProduct
description: '# Collection of Product Group Products.'
tags:
- Catalog
parameters:
- name: product_group_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Product'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Product'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/catalog/groups/{product_group_id}/products/{id}:
delete:
operationId: dp_catalog_group_products_detail_destroyProduct
description: '# Collection of Product Group Products.'
tags:
- Catalog
parameters:
- name: product_group_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: Product ID
schema:
type: string
responses:
'204':
description: ''
/categories:
get:
operationId: dp_category_list_listListCategories
description: 'This API of system product categories is DEPRECATED. Please, use
PIM
Categories and Taxonomies APIs instead to handle product categorization per
Distributor.'
tags:
- Products
parameters:
- $ref: '#/components/parameters/dp.CategoriesPagination.limit'
- $ref: '#/components/parameters/dp.CategoriesPagination.offset'
- name: family.id
description: 'Filter for: family.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: parent.id
description: 'Filter for: parent.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ListCategory'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/categories/{id}:
get:
operationId: dp_category_detail_retrieveCategory
description: 'This API of system product categories is DEPRECATED. Please, use
PIM
Categories and Taxonomies APIs instead to handle product categorization per
Distributor.'
tags:
- Products
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Category'
description: ''
/contracts:
get:
operationId: dp_contract_list_listContracts
description: ''
tags:
- Contracts
parameters:
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: agreement.id
description: 'Filter for: agreement.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.name
description: 'Filter for: agreement.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.owner.id
description: 'Filter for: agreement.owner.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.product_groups.id
description: 'Filter for: agreement.product_groups.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.product_groups.products.id
description: 'Filter for: agreement.product_groups.products.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.sourcing_agreement.id
description: 'Filter for: agreement.sourcing_agreement.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement.sourcing_agreement.type
description: 'Filter for: agreement.sourcing_agreement.type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- distribution
- program
- service
- syndication
- referral
- name: agreement__id
description: 'Filter for: agreement__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement__name
description: 'Filter for: agreement__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: agreement__owner__id
description: 'Filter for: agreement__owner__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.signed.by.id
description: 'Filter for: events.signed.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.signed.by.name
description: 'Filter for: events.signed.by.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: issuer.id
description: 'Filter for: issuer.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: issuer.name
description: 'Filter for: issuer.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: kind
description: 'Filter for: kind
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- production
- test
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__id
description: 'Filter for: marketplace__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__name
description: 'Filter for: marketplace__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.id
description: 'Filter for: owner.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.name
description: 'Filter for: owner.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner__id
description: 'Filter for: owner__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner__name
description: 'Filter for: owner__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: partner.id
description: 'Filter for: partner.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: referral.agreement.id
description: 'Filter for: referral.agreement.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sourcing.listing.id
description: 'Filter for: sourcing.listing.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sourcing.marketplace.id
description: 'Filter for: sourcing.marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sourcing.marketplace.name
description: 'Filter for: sourcing.marketplace.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sourcing.product.id
description: 'Filter for: sourcing.product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sourcing.product.name
description: 'Filter for: sourcing.product.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- new
- enrolling
- pending
- active
- terminated
- rejected
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- distribution
- program
- service
- syndication
- referral
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Contract'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/contracts/{contract_id}/data:
get:
operationId: dp_enroll_distribution_data_list_listDistributionDatas
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_enroll_distribution_data_list_createDistributionData
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/contracts/{contract_id}/data/products:
get:
operationId: dp_product_distribution_data_list_listDistributionDatas
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_distribution_data_list_createDistributionData
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/contracts/{contract_id}/data/products/{id}:
get:
operationId: dp_product_distribution_data_detail_retrieveDistributionData
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Distribution Data.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
put:
operationId: dp_product_distribution_data_detail_updateDistributionData
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Distribution Data.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/contracts/{contract_id}/data/products/{product_id}/items:
get:
operationId: dp_item_distribution_data_list_listDistributionDatas
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- name: product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_item_distribution_data_list_createDistributionData
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- name: product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/contracts/{contract_id}/data/products/{product_id}/items/{id}:
get:
operationId: dp_item_distribution_data_detail_retrieveDistributionData
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- name: product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Distribution Data.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
put:
operationId: dp_item_distribution_data_detail_updateDistributionData
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- name: product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Distribution Data.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.DistributionData'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/contracts/{contract_id}/versions:
get:
operationId: dp_contract_versions_list_listContractVersionUsers
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ContractVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/contracts/{contract_id}/versions/{version__version}:
get:
operationId: dp_contract_versions_detail_retrieveContractVersionUser
description: ''
tags:
- Contracts
parameters:
- name: contract_id
in: path
required: true
description: ''
schema:
type: string
- name: version__version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ContractVersion'
description: ''
/contracts/{id}:
get:
operationId: dp_contract_detail_retrieveContract
description: Get base object or redirect to object version.
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Contract'
description: ''
put:
operationId: dp_contract_detail_updateContract
description: ''
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Contract'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Contract'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_contract_detail_destroyContract
description: ''
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
responses:
'204':
description: ''
/contracts/{id}/enroll:
post:
operationId: dp_contract_enroll_postEnrollContract
description: ''
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
responses:
'200':
description: ''
/contracts/{id}/refine:
post:
operationId: dp_contract_refine_postRefineContract
description: ''
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
responses:
'200':
description: ''
/contracts/{id}/reject:
post:
operationId: dp_contract_reject_postRejectContract
description: ''
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
responses:
'200':
description: ''
/contracts/{id}/sign:
post:
operationId: dp_contract_sign_postSignContract
description: ''
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
responses:
'200':
description: ''
/contracts/{id}/terminate:
post:
operationId: dp_contract_terminate_postTerminateContract
description: ''
tags:
- Contracts
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Contract.
schema:
type: string
responses:
'200':
description: ''
/countries:
get:
operationId: dp_country_list_listCountries
description: ''
tags:
- Marketplaces
parameters:
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Country'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/countries/{id}:
get:
operationId: dp_country_detail_retrieveCountry
description: ''
tags:
- Marketplaces
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Country.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Country'
description: ''
/forms:
get:
operationId: dp_agreement_forms_list_listAgreementFormVersions
description: ''
tags:
- Agreements
parameters:
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- enroll
- product
- item
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.AgreementForm'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_agreement_forms_list_createAgreementFormVersion
description: ''
tags:
- Agreements
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementForm'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementForm'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/forms/{agreement_form_id}/versions:
get:
operationId: dp_agreement_form_versions_list_listAgreementFormVersions
description: ''
tags:
- Agreements
parameters:
- name: agreement_form_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.AgreementFormVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/forms/{agreement_form_id}/versions/{version}:
get:
operationId: dp_agreement_form_versions_detail_retrieveAgreementFormVersion
description: ''
tags:
- Agreements
parameters:
- name: agreement_form_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementFormVersion'
description: ''
/forms/{id}:
get:
operationId: dp_agreement_forms_detail_retrieveAgreementFormVersion
description: Get base object or redirect to object version.
tags:
- Agreements
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Agreement Form Version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementForm'
description: ''
put:
operationId: dp_agreement_forms_detail_updateAgreementFormVersion
description: ''
tags:
- Agreements
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Agreement Form Version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementForm'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.AgreementForm'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_agreement_forms_detail_destroyAgreementFormVersion
description: ''
tags:
- Agreements
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Agreement Form Version.
schema:
type: string
responses:
'204':
description: ''
/hubs:
get:
operationId: dp_hubs_list_listHubs
description: ''
tags:
- Hubs
parameters:
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events__created__at
description: 'Filter for: events__created__at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events__updated__at
description: 'Filter for: events__updated__at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: instance.id
description: 'Filter for: instance.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: instance.type
description: 'Filter for: instance.type
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- oa
- api
- name: instance__id
description: 'Filter for: instance__id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: instance__type
description: 'Filter for: instance__type
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- oa
- api
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.connections
description: 'Filter for: stats.connections
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.marketplaces
description: 'Filter for: stats.marketplaces
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats__connections
description: 'Filter for: stats__connections
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats__marketplaces
description: 'Filter for: stats__marketplaces
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Hub'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_hubs_list_createHub
description: ''
tags:
- Hubs
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Hub'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Hub'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/hubs/{hub_id}/connections:
get:
operationId: dp_hub_connections_list_listConnectionReferences
description: ''
tags:
- Hubs
parameters:
- name: hub_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: created_at
description: 'Filter for: created_at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product__name
description: 'Filter for: product__name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ConnectionReference'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/hubs/{hub_id}/marketplaces:
get:
operationId: dp_hub_marketplaces_list_listHubReferenceMarketplaces
description: ''
tags:
- Hubs
parameters:
- name: hub_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.HubReferenceMarketplace'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/hubs/{id}:
get:
operationId: dp_hubs_detail_retrieveHub
description: ''
tags:
- Hubs
parameters:
- name: id
in: path
required: true
description: A unique value identifying this hub.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Hub'
description: ''
put:
operationId: dp_hubs_detail_updateHub
description: ''
tags:
- Hubs
parameters:
- name: id
in: path
required: true
description: A unique value identifying this hub.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Hub'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Hub'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_hubs_detail_destroyHub
description: ''
tags:
- Hubs
parameters:
- name: id
in: path
required: true
description: A unique value identifying this hub.
schema:
type: string
responses:
'204':
description: ''
/listing-requests:
get:
operationId: dp_listingrequest_list_listListingRequests
description: ''
tags:
- Listings
parameters:
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: contract__id
description: 'Filter for: contract__id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract__name
description: 'Filter for: contract__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: created
description: 'Filter for: created
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.contract.id
description: 'Filter for: listing.contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.contract.marketplace.id
description: 'Filter for: listing.contract.marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.contract.marketplace.name
description: 'Filter for: listing.contract.marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.contract.name
description: 'Filter for: listing.contract.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.id
description: 'Filter for: listing.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.marketplace.id
description: 'Filter for: listing.marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.marketplace.name
description: 'Filter for: listing.marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.product.id
description: 'Filter for: listing.product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.product.name
description: 'Filter for: listing.product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.product.version
description: 'Filter for: listing.product.version
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: integer
- name: listing.provider.id
description: 'Filter for: listing.provider.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.provider.name
description: 'Filter for: listing.provider.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.vendor.id
description: 'Filter for: listing.vendor.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing.vendor.name
description: 'Filter for: listing.vendor.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: listing__id
description: 'Filter for: listing__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__id
description: 'Filter for: marketplace__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__name
description: 'Filter for: marketplace__name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.version
description: 'Filter for: product.version
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: product__id
description: 'Filter for: product__id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product__name
description: 'Filter for: product__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product__version
description: 'Filter for: product__version
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: provider__id
description: 'Filter for: provider__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider__name
description: 'Filter for: provider__name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: state
description: 'Filter for: state
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- reviewing
- deploying
- canceled
- completed
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- unlisted
- listed
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- new
- remove
- name: updated
description: 'Filter for: updated
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: vendor__id
description: 'Filter for: vendor__id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: vendor__name
description: 'Filter for: vendor__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ListingRequest'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_listingrequest_list_createListingRequest
description: ''
tags:
- Listings
parameters: []
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
properties:
type:
type: string
enum:
- new
- update
- remove
note:
type: string
product_id:
type: string
contract_id:
type: string
- type: object
properties:
type:
type: string
enum:
- update
- remove
note:
type: string
listing_id:
type: string
discriminator:
propertyName: type
description: ''
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ListingRequest'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/listing-requests/{id}:
get:
operationId: dp_listingrequest_detail_retrieveListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ListingRequest'
description: ''
/listing-requests/{id}/assign:
post:
operationId: dp_listingrequest_assign_postAssignListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
description: ''
/listing-requests/{id}/cancel:
post:
operationId: dp_listingrequest_cancel_postCancelListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
description: ''
/listing-requests/{id}/complete:
post:
operationId: dp_listingrequest_complete_postCompleteListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
description: ''
/listing-requests/{id}/deploy:
post:
operationId: dp_listingrequest_deploy_postDeployListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
description: ''
/listing-requests/{id}/refine:
post:
operationId: dp_listingrequest_refine_postRefineListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
description: ''
/listing-requests/{id}/submit:
post:
operationId: dp_listingrequest_submit_postSubmitListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
description: ''
/listing-requests/{id}/unassign:
post:
operationId: dp_listingrequest_unassign_postUnassignListingRequest
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing request.
schema:
type: string
responses:
'200':
description: ''
/listings:
get:
operationId: dp_listing_list_listListings
description: ''
tags:
- Listings
parameters:
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract__id
description: 'Filter for: contract__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract__marketplace__name
description: 'Filter for: contract__marketplace__name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: created
description: 'Filter for: created
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__id
description: 'Filter for: marketplace__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__name
description: 'Filter for: marketplace__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__name__icontains
description: 'Filter for: marketplace__name__icontains
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: offer.id
description: 'Filter for: offer.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: offer.name
description: 'Filter for: offer.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request.status
description: 'Filter for: pending_request.status
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request.type
description: 'Filter for: pending_request.type
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request__id
description: 'Filter for: pending_request__id
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: pending_request__is_null
description: 'Filter for: pending_request__is_null
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.id
description: 'Filter for: pricelist.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.name
description: 'Filter for: pricelist.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product__id
description: 'Filter for: product__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product__name
description: 'Filter for: product__name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product__name__icontains
description: 'Filter for: product__name__icontains
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider.id
description: 'Filter for: provider.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider.name
description: 'Filter for: provider.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider__id
description: 'Filter for: provider__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- unlisted
- listed
- name: updated
description: 'Filter for: updated
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: vendor.id
description: 'Filter for: vendor.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: vendor.name
description: 'Filter for: vendor.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Listing'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/listings/{id}:
get:
operationId: dp_listing_detail_retrieveListing
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Listing'
description: ''
put:
operationId: dp_listing_detail_updateListing
description: ''
tags:
- Listings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this listing.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Listing'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Listing'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/marketplaces:
get:
operationId: dp_marketplace_list_listMarketplaces
description: ''
tags:
- Marketplaces
parameters:
- $ref: '#/components/parameters/dp.RQL1000Pagination.limit'
- $ref: '#/components/parameters/dp.RQL1000Pagination.offset'
- name: agreements.id
description: 'Filter for: agreements.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: countries.id
description: 'Filter for: countries.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: currency
description: 'Filter for: currency
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UYW
- UZS
- VED
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
- name: description
description: 'Filter for: description
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: hubs.id
description: 'Filter for: hubs.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: hubs.name
description: 'Filter for: hubs.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: locales.id
description: 'Filter for: locales.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: locales.name
description: 'Filter for: locales.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.id
description: 'Filter for: owner.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.name
description: 'Filter for: owner.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner__id
description: 'Filter for: owner__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.contracts
description: 'Filter for: stats.contracts
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.hubs
description: 'Filter for: stats.hubs
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Marketplace'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_marketplace_list_createMarketplace
description: ''
tags:
- Marketplaces
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Marketplace'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Marketplace'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/marketplaces/{id}:
get:
operationId: dp_marketplace_detail_retrieveMarketplace
description: ''
tags:
- Marketplaces
parameters:
- name: id
in: path
required: true
description: A unique value identifying this marketplace.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Marketplace'
description: ''
put:
operationId: dp_marketplace_detail_updateMarketplace
description: ''
tags:
- Marketplaces
parameters:
- name: id
in: path
required: true
description: A unique value identifying this marketplace.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Marketplace'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Marketplace'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_marketplace_detail_destroyMarketplace
description: ''
tags:
- Marketplaces
parameters:
- name: id
in: path
required: true
description: A unique value identifying this marketplace.
schema:
type: string
responses:
'204':
description: ''
/marketplaces/{id}/icon:
post:
operationId: dp_marketplace_icon_postIconMarketplace
description: ''
tags:
- Marketplaces
parameters:
- name: id
in: path
required: true
description: A unique value identifying this marketplace.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.MarketplaceIcon'
responses:
'200':
description: ''
/news:
get:
operationId: dp_news_list_listPosts
description: ''
tags:
- Partners
parameters:
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: audience
description: 'Filter for: audience
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- private
- vendor
- reseller
- distributor
- any
- name: content
description: 'Filter for: content
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: creator.id
description: 'Filter for: creator.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: creator.name
description: 'Filter for: creator.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.drafted.at
description: 'Filter for: events.drafted.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.published.at
description: 'Filter for: events.published.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- published
- deleted
- name: subtitle
description: 'Filter for: subtitle
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: title
description: 'Filter for: title
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Post'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_news_list_createPostCreate
description: ''
tags:
- Partners
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.PostCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.PostCreate'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/news/{id}:
get:
operationId: dp_news_detail_retrievePost
description: Get base object or redirect to object version.
tags:
- Partners
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Post'
description: ''
put:
operationId: dp_news_detail_updatePostUpdate
description: ''
tags:
- Partners
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.PostUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.PostUpdate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_news_detail_destroyPost
description: ''
tags:
- Partners
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/news/{id}/draft:
post:
operationId: dp_news_draft_postDraftPost
description: ''
tags:
- Partners
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Post'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Post'
description: ''
/news/{id}/publish:
post:
operationId: dp_news_publish_postPublishPost
description: ''
tags:
- Partners
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Post'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Post'
description: ''
/news/{post_pk}/versions:
get:
operationId: dp_news_versions_list_listPostVersions
description: ''
tags:
- Partners
parameters:
- name: post_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.PostVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/news/{post_pk}/versions/{version}:
get:
operationId: dp_news_versions_detail_retrievePostVersion
description: ''
tags:
- Partners
parameters:
- name: post_pk
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.PostVersion'
description: ''
/partners:
get:
operationId: dp_partner_list_listPartners
description: ''
tags:
- Partners
parameters:
- $ref: '#/components/parameters/dp.PartnersPagination.limit'
- $ref: '#/components/parameters/dp.PartnersPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: public
description: 'Filter for: public
**lookups:** eq, ne, null'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: role
description: 'Filter for: role
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- vendor
- distributor
- reseller
- name: stats.contracts.distribution
description: 'Filter for: stats.contracts.distribution
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.contracts.program
description: 'Filter for: stats.contracts.program
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.contracts.service
description: 'Filter for: stats.contracts.service
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.contracts.syndication
description: 'Filter for: stats.contracts.syndication
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.listings
description: 'Filter for: stats.listings
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- invited
- active
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- vendor
- provider
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Partner'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/partners/{partner_pk}/products:
get:
operationId: dp_partner_products_list_listPartnerProductsViewSets
description: ''
tags:
- Partners
parameters:
- name: partner_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/partners/{partner_pk}/products/{id}:
get:
operationId: dp_partner_products_detail_retrievePartnerProductsViewSet
description: ''
tags:
- Partners
parameters:
- name: partner_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/partners/{id}:
get:
operationId: dp_partner_detail_retrievePartner
description: ''
tags:
- Partners
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Partner'
description: ''
/products:
get:
operationId: dp_products_list_listProductVersions
description: ''
tags:
- Products
parameters:
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.published.at
description: 'Filter for: events.published.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.published.by.id
description: 'Filter for: events.published.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.published.by.name
description: 'Filter for: events.published.by.name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.by.id
description: 'Filter for: events.updated.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.by.name
description: 'Filter for: events.updated.by.name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: groups.id
description: 'Filter for: groups.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.id
description: 'Filter for: owner.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.name
description: 'Filter for: owner.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: purchase_model
description: 'Filter for: purchase_model
**lookups:** eq, ne, in'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- transactable
- referral
- name: replacement.id
description: 'Filter for: replacement.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sourcing.marketplaces
description: 'Filter for: sourcing.marketplaces
**lookups:** eq, ne, ilike, null, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- indevelopment
- oncertification
- published
- initializationfailed
- deleted
- endofsale
- name: visibility.catalog
description: 'Filter for: visibility.catalog
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: visibility.listing
description: 'Filter for: visibility.listing
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: visibility.owner
description: 'Filter for: visibility.owner
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: visibility.syndication
description: 'Filter for: visibility.syndication
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: category.id
description: 'System categories are now deprecated. Please, use PIM categories
instead.
**lookups:** eq'
in: query
required: false
deprecated: true
schema:
type: string
- name: category.parent
description: 'System categories are now deprecated. Please, use PIM categories
instead.
**lookups:** '
in: query
required: false
deprecated: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_products_list_createProductCreate
description: ''
tags:
- Products
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductCreate'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_id}:
get:
operationId: dp_products_detail_retrieveProductVersion
description: ''
tags:
- Products
parameters:
- name: product_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
put:
operationId: dp_products_detail_updateProductMasterVersionUpdate
description: ''
tags:
- Products
parameters:
- name: product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductMasterVersionUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductMasterVersionUpdate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_products_detail_destroyProductVersion
description: ''
tags:
- Products
parameters:
- name: product_id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/products/{product_id}/endsale:
post:
operationId: dp_products_endsale_postEndsaleProductVersion
description: ''
tags:
- Products
parameters:
- name: product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
replacement:
type: object
properties:
id:
type: string
end_of_sale_notes:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
/products/{product_id}/resumesale:
post:
operationId: dp_products_resumesale_postResumesaleProductVersion
description: ''
tags:
- Products
parameters:
- name: product_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
/products/{product_product_id}/actions:
get:
operationId: dp_product_actions_list_listActions
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- asset
- tier1
- tier2
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductActions'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_actions_list_createAction
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductActions'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductActions'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/actions/regeneratesecret:
post:
operationId: dp_product_actions_regeneratesecret_postRegeneratesecretAction
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.RegenerateSecret'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.RegenerateSecret'
description: ''
/products/{product_product_id}/actions/{id}:
get:
operationId: dp_product_actions_detail_retrieveAction
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this action.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductActions'
description: ''
put:
operationId: dp_product_actions_detail_updateAction
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this action.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductActions'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductActions'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_product_actions_detail_destroyAction
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this action.
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/actions/{id}/actionLink:
get:
operationId: dp_product_actions_get_action_link_getGet_action_linkAction
description: Generate the action link url. Either the `asset_id` or `tier_config_id`
parameter should be passed as a query parameter
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this action.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
link:
type: string
format: uri
description: ''
/products/{product_product_id}/configurations:
get:
operationId: dp_product_configurations_list_listProductConfigurationDataViews
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.ProductConfigurationDataPagination.limit'
- $ref: '#/components/parameters/dp.ProductConfigurationDataPagination.offset'
- name: item.id
description: 'Filter for: item.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.name
description: 'Filter for: item.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: parameter.constraints.required
description: 'Filter for: parameter.constraints.required
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: parameter.constraints.shared
description: 'Filter for: parameter.constraints.shared
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- view
- edit
- name: parameter.id
description: 'Filter for: parameter.id
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: parameter.scope
description: 'Filter for: parameter.scope
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: parameter.title
description: 'Filter for: parameter.title
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: value
description: 'Filter for: value
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ConfigurationDataRead'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_configurations_list_createProductConfigurationDataView
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ConfigurationDataWrite'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ConfigurationDataWrite'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/connections:
get:
operationId: dp_product_connections_list_listConnections
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: hub.id
description: 'Filter for: hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** HB-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.instance.id
description: 'Filter for: hub.instance.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.name
description: 'Filter for: hub.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product_version_type
description: 'Filter for: product_version_type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- public
- staging
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Connection'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_connections_list_createConnection
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/connections/{id}:
get:
operationId: dp_product_connections_detail_retrieveConnection
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this connection.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
description: ''
put:
operationId: dp_product_connections_detail_updateConnection
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this connection.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/products/{product_product_id}/item-groups:
get:
operationId: dp_product_item_groups_list_listItemGroupDetaileds
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: created_at
description: 'Filter for: created_at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: mpn
description: 'Filter for: mpn
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items: {}
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_item_groups_list_createItemGroupCreate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'201':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/item-groups/{id}:
get:
operationId: dp_product_item_groups_detail_retrieveItemGroupDetailed
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema: {}
description: ''
put:
operationId: dp_product_item_groups_detail_updateItemGroupUpdate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_product_item_groups_detail_destroyItemGroupDetailed
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/items:
get:
operationId: dp_product_items_list_listUiItems
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: app.id
description: 'Filter for: app.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: commitment.count
description: 'Filter for: commitment.count
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: integer
- name: description.value
description: 'Filter for: description.value
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: display_name
description: 'Filter for: display_name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: dynamic
description: 'Filter for: dynamic
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.saleended.at
description: 'Filter for: events.saleended.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: frozen
description: 'Filter for: frozen
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: group.id
description: 'Filter for: group.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.mpn
description: 'Filter for: group.mpn
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.name
description: 'Filter for: group.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item_type
description: 'Filter for: item_type
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Reservation
- PPU
- name: local_id
description: 'Filter for: local_id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: mpn
description: 'Filter for: mpn
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: period
description: 'Filter for: period
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Monthly
- Yearly
- years_2
- years_3
- years_4
- years_5
- years_6
- OneTime
- name: replacement.id
description: 'Filter for: replacement.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- published
- endofsale
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Reservation
- PPU
- name: unit.title
description: 'Filter for: unit.title
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: usage_data_type
description: 'Filter for: usage_data_type
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Integer
- Decimal(1)
- Decimal(2)
- Decimal(4)
- Decimal(8)
- name: verbose_id
description: 'Filter for: verbose_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: version
description: 'Filter for: version
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.UIItem'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_items_list_createItemCreate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ItemCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ItemCreate'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/items/{verbose_id}:
get:
operationId: dp_product_items_detail_retrieveUIItem
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: verbose_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.UIItem'
description: ''
put:
operationId: dp_product_items_detail_updateItemUpdate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: verbose_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ItemUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ItemUpdate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_product_items_detail_destroyUIItem
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: verbose_id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/items/{verbose_id}/endsale:
post:
operationId: dp_product_items_endsale_postEndsaleUIItem
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: verbose_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
replacement:
type: object
properties:
id:
type: string
end_of_sale_notes:
type: string
responses:
'200':
description: ''
/products/{product_product_id}/items/{verbose_id}/resumesale:
post:
operationId: dp_product_items_resumesale_postResumesaleUIItem
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: verbose_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
description: ''
/products/{product_product_id}/localizations:
get:
operationId: dp_product_localizations_list_listProductLocalizationsReads
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items: {}
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_localizations_list_createProductLocalizationsCreate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'201':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/localizations/{locale}:
get:
operationId: dp_product_localizations_detail_retrieveProductLocalizationsRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: locale
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema: {}
description: ''
delete:
operationId: dp_product_localizations_detail_destroyProductLocalizationsRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: locale
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/localizations/{locale}/download:
get:
operationId: dp_product_localizations_download_getDownloadProductLocalizationsRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: locale
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
text/x-gettext-translation:
schema:
type: string
description: ''
/products/{product_product_id}/media:
get:
operationId: dp_product_media_list_listProductVersionMediaReads
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- image
- video
- name: url
description: 'Filter for: url
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
thumbnail:
type: string
url:
type: string
readOnly: true
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_media_list_createProductVersionMediaCreate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersionMediaCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersionMediaCreate'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/media/{media_id}:
get:
operationId: dp_product_media_detail_retrieveProductVersionMediaRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: media_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
thumbnail:
type: string
url:
type: string
readOnly: true
description: ''
put:
operationId: dp_product_media_detail_updateProductVersionMediaUpdate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: media_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersionMediaUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersionMediaUpdate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_product_media_detail_destroyProductVersionMediaRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: media_id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/messages:
get:
operationId: dp_product_messages_list_listProductMessages
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: auto
description: 'Filter for: auto
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: value
description: 'Filter for: value
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductMessage'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_messages_list_createProductMessage
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
external_id:
type: string
value:
type: string
auto:
type: boolean
required:
- external_id
- value
responses:
'201':
description: ''
content:
application/json:
schema:
type: object
properties:
id:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
external_id:
type: string
value:
type: string
auto:
type: boolean
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/messages/{id}:
get:
operationId: dp_product_messages_detail_retrieveProductMessage
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Product Error Messages.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductMessage'
description: ''
put:
operationId: dp_product_messages_detail_updateProductMessage
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Product Error Messages.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
external_id:
type: string
value:
type: string
auto:
type: boolean
required:
- external_id
- value
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
id:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
external_id:
type: string
value:
type: string
auto:
type: boolean
'400':
$ref: '#/components/responses/dp.create_400'
delete:
operationId: dp_product_messages_detail_destroyProductMessage
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Product Error Messages.
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/parameters:
get:
operationId: dp_product_parameters_list_listParameterReads
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp._ParamsPagination.limit'
- $ref: '#/components/parameters/dp._ParamsPagination.offset'
- name: constraints.hidden
description: 'Filter for: constraints.hidden
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: constraints.reconciliation
description: 'Filter for: constraints.reconciliation
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: constraints.required
description: 'Filter for: constraints.required
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: constraints.shared
description: 'Filter for: constraints.shared
**lookups:** eq, null, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: constraints.unique
description: 'Filter for: constraints.unique
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: phase
description: 'Filter for: phase
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- configuration
- fulfillment
- ordering
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- asset
- tier1
- tier2
- product
- item
- marketplace
- item_marketplace
- name: title
description: 'Filter for: title
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- address
- phone
- object
- url
- choice
- heading
- content
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ParameterRead'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_parameters_list_createParameterCreate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ParameterCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ParameterRead'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/parameters/{parameter__verbose_id}:
get:
operationId: dp_product_parameters_detail_retrieveParameterRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: parameter__verbose_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ParameterRead'
description: ''
put:
operationId: dp_product_parameters_detail_updateParameterUpdate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: parameter__verbose_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ParameterUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ParameterRead'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_product_parameters_detail_destroyParameterRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: parameter__verbose_id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/templates:
get:
operationId: dp_product_templates_list_listTemplates
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- asset
- tier1
- tier2
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- inquire
- fulfillment
- pending
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductTemplates'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_templates_list_createTemplate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductTemplates'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductTemplates'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/templates/{id}:
get:
operationId: dp_product_templates_detail_retrieveTemplate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this template.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductTemplates'
description: ''
put:
operationId: dp_product_templates_detail_updateTemplate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this template.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductTemplatesUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductTemplatesUpdate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_product_templates_detail_destroyTemplate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this template.
schema:
type: string
responses:
'204':
description: ''
/products/{product_product_id}/templates/{id}/preview:
get:
operationId: dp_product_templates_preview_getPreviewTemplate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this template.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
description: ''
/products/{product_product_id}/templates/{id}/render:
get:
operationId: dp_product_templates_render_getRenderTemplate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this template.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: string
description: ''
/products/{product_product_id}/versions:
get:
operationId: dp_product_versions_list_listProductVersions
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: public
description: 'Filter for: public
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: staging
description: 'Filter for: staging
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: version
description: 'Filter for: version
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_versions_list_createProductVersion
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'201':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/versions/{version_version}/actions:
get:
operationId: dp_product_version_actions_list_listProductAction
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- asset
- tier1
- tier2
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductActions'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/products/{product_product_id}/versions/{version_version}/actions/{id}:
get:
operationId: dp_product_version_actions_detail_retrieveProductActions
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductActions'
description: ''
/products/{product_product_id}/versions/{version_version}/actions/{id}/actionLink:
get:
operationId: dp_product_version_actions_get_action_link_getGet_action_linkProductActions
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductActions'
description: ''
/products/{product_product_id}/versions/{version_version}/connections:
get:
operationId: dp_product_version_connections_list_listConnections
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: hub.id
description: 'Filter for: hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** HB-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.instance.id
description: 'Filter for: hub.instance.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.name
description: 'Filter for: hub.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product_version_type
description: 'Filter for: product_version_type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- public
- staging
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.Connection'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_product_version_connections_list_createConnection
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/products/{product_product_id}/versions/{version_version}/connections/{id}:
get:
operationId: dp_product_version_connections_detail_retrieveConnection
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this connection.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
description: ''
put:
operationId: dp_product_version_connections_detail_updateConnection
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this connection.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.Connection'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/products/{product_product_id}/versions/{version_version}/item-groups:
get:
operationId: dp_product_version_item_groups_list_listItemGroupDetaileds
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: created_at
description: 'Filter for: created_at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: mpn
description: 'Filter for: mpn
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items: {}
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/products/{product_product_id}/versions/{version_version}/item-groups/{id}:
get:
operationId: dp_product_version_item_groups_detail_retrieveItemGroupDetailed
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema: {}
description: ''
/products/{product_product_id}/versions/{version_version}/items:
get:
operationId: dp_product_version_items_list_listUiItems
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: app.id
description: 'Filter for: app.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: commitment.count
description: 'Filter for: commitment.count
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: integer
- name: description.value
description: 'Filter for: description.value
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: display_name
description: 'Filter for: display_name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: dynamic
description: 'Filter for: dynamic
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.saleended.at
description: 'Filter for: events.saleended.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: frozen
description: 'Filter for: frozen
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: group.id
description: 'Filter for: group.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.mpn
description: 'Filter for: group.mpn
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.name
description: 'Filter for: group.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item_type
description: 'Filter for: item_type
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Reservation
- PPU
- name: local_id
description: 'Filter for: local_id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: mpn
description: 'Filter for: mpn
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: period
description: 'Filter for: period
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Monthly
- Yearly
- years_2
- years_3
- years_4
- years_5
- years_6
- OneTime
- name: replacement.id
description: 'Filter for: replacement.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- published
- endofsale
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Reservation
- PPU
- name: unit.title
description: 'Filter for: unit.title
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: usage_data_type
description: 'Filter for: usage_data_type
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Integer
- Decimal(1)
- Decimal(2)
- Decimal(4)
- Decimal(8)
- name: verbose_id
description: 'Filter for: verbose_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: version
description: 'Filter for: version
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.UIItem'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/products/{product_product_id}/versions/{version_version}/items/{verbose_id}:
get:
operationId: dp_product_version_items_detail_retrieveUIItem
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: verbose_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.UIItem'
description: ''
/products/{product_product_id}/versions/{version_version}/media:
get:
operationId: dp_product_version_media_list_listProductVersionMediaReads
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- image
- video
- name: url
description: 'Filter for: url
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
thumbnail:
type: string
url:
type: string
readOnly: true
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/products/{product_product_id}/versions/{version_version}/media/{media_id}:
get:
operationId: dp_product_version_media_detail_retrieveProductVersionMediaRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: media_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
thumbnail:
type: string
url:
type: string
readOnly: true
description: ''
/products/{product_product_id}/versions/{version_version}/parameters:
get:
operationId: dp_product_version_parameters_list_listParameterReads
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: constraints.hidden
description: 'Filter for: constraints.hidden
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: constraints.reconciliation
description: 'Filter for: constraints.reconciliation
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: constraints.required
description: 'Filter for: constraints.required
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: constraints.shared
description: 'Filter for: constraints.shared
**lookups:** eq, null, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: constraints.unique
description: 'Filter for: constraints.unique
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: phase
description: 'Filter for: phase
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- configuration
- fulfillment
- ordering
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- asset
- tier1
- tier2
- product
- item
- marketplace
- item_marketplace
- name: title
description: 'Filter for: title
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- address
- phone
- object
- url
- choice
- heading
- content
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ParameterRead'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/products/{product_product_id}/versions/{version_version}/parameters/{parameter__verbose_id}:
get:
operationId: dp_product_version_parameters_detail_retrieveParameterRead
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: parameter__verbose_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ParameterRead'
description: ''
/products/{product_product_id}/versions/{version_version}/templates:
get:
operationId: dp_product_version_templates_list_listProductTemplate
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- asset
- tier1
- tier2
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- inquire
- fulfillment
- pending
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.ProductTemplates'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/products/{product_product_id}/versions/{version_version}/templates/{id}:
get:
operationId: dp_product_version_templates_detail_retrieveProductTemplates
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version_version
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductTemplates'
description: ''
/products/{product_product_id}/versions/{version}:
get:
operationId: dp_product_versions_detail_retrieveProductVersion
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
put:
operationId: dp_product_versions_detail_updateProductVersion
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersionCreateUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersionCreateUpdate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/products/{product_product_id}/versions/{version}/build:
post:
operationId: dp_product_versions_build_postBuildProductVersion
description: ''
tags:
- Products
parameters:
- name: product_product_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.ProductVersion'
description: ''
/requests:
get:
operationId: dp_request_list_listRequests
description: 'Requests endpoints allows the creation of different kind of requests
to handle the life cycle
of Assets.'
tags:
- Assets
parameters:
- $ref: '#/components/parameters/dp.MySQLandRQL1000Pagination.limit'
- $ref: '#/components/parameters/dp.MySQLandRQL1000Pagination.offset'
- name: activation_key
description: 'This filter is used for explicit negative select. For example,
select(-activation_key). It will not return "activation_key" property in
the response. Combining it together with select(-template), i.e. doing select(-activation_key,-template),
may dramatically increase /requests API performance. Please consider using
those two negative selects if in your application you do not need to treat
neither "activation_key" field nor "template" object.
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.account_id
description: 'Filter for: asset.account_id
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.configuration
description: 'This filter is used for explicit negative select. For example,
select(-configuration). It will not return "configuration" object in the
response. Please consider using this negative select if in your application
you do not need to treat "configuration" object, it may dramatically increase
/requests API performance.
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.environment
description: 'Filter for: asset.connection.environment
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: asset.connection.hub.id
description: 'Filter for: asset.connection.hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** HB-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.hub.name
description: 'Filter for: asset.connection.hub.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.id
description: 'Filter for: asset.connection.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CT-0000-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.provider.id
description: 'Filter for: asset.connection.provider.id
**lookups:** eq, ilike, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.provider.name
description: 'Filter for: asset.connection.provider.name
**lookups:** eq, ilike'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.type
description: 'Filter for: asset.connection.type
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: asset.connection.vendor.id
description: 'Filter for: asset.connection.vendor.id
**lookups:** eq, ilike, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.connection.vendor.name
description: 'Filter for: asset.connection.vendor.name
**lookups:** eq, ilike'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.contract.id
description: 'Filter for: asset.contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.external.id
description: 'Filter for: asset.external.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.external_id
description: 'Filter for: asset.external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.external_uid
description: 'Filter for: asset.external_uid
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.id
description: 'Filter for: asset.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.items
description: 'This filter is used for explicit negative select. For example,
select(-items). It will not return "items" list in the response. Please
consider using this negative select if in your application you do not need
to treat "items" list, it may dramatically increase /requests API performance.
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.marketplace.id
description: 'Filter for: asset.marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** MP-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.marketplace.name
description: 'Filter for: asset.marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.params.id
description: 'Filter for: asset.params.id
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.params.value
description: 'Filter for: asset.params.value
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.product.capabilities
description: "This filter is used for explicit select. For example, select(asset.product.capabilities).\
\ It will return additionally product capabilities in the response.\n\n\
**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.product.id
description: 'Filter for: asset.product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.product.name
description: 'Filter for: asset.product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.status
description: 'Filter for: asset.status
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- processing
- active
- terminating
- suspended
- terminated
- name: asset.tier1_id
description: 'Filter for: asset.tier1_id
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tier2_id
description: 'Filter for: asset.tier2_id
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.customer.id
description: 'Filter for: asset.tiers.customer.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.customer.name
description: 'Filter for: asset.tiers.customer.name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.tier1.id
description: 'Filter for: asset.tiers.tier1.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.tier2
description: 'Filter for: asset.tiers.tier2
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.tiers.tier2.id
description: 'Filter for: asset.tiers.tier2.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__connection__environment
description: 'Filter for: asset__connection__environment
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: asset__connection__hub__id
description: 'Filter for: asset__connection__hub__id
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__connection__hub__name
description: 'Filter for: asset__connection__hub__name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__connection__provider__id
description: 'Filter for: asset__connection__provider__id
**lookups:** eq, ilike, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__connection__provider__name
description: 'Filter for: asset__connection__provider__name
**lookups:** eq, ilike'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__connection__type
description: 'Filter for: asset__connection__type
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: asset__connection__vendor__id
description: 'Filter for: asset__connection__vendor__id
**lookups:** eq, ilike, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__connection__vendor__name
description: 'Filter for: asset__connection__vendor__name
**lookups:** eq, ilike'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__id
description: 'Filter for: asset__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__product__id
description: 'Filter for: asset__product__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__product__name
description: 'Filter for: asset__product__name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__tiers__customer__id
description: 'Filter for: asset__tiers__customer__id
**lookups:** eq
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__tiers__tier1__id
description: 'Filter for: asset__tiers__tier1__id
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset__tiers__tier2__id
description: 'Filter for: asset__tiers__tier2__id
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset_id
description: 'Filter for: asset_id
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: assignee
description: 'Filter for: assignee
**lookups:** eq, null, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: assignee.email
description: 'Filter for: assignee.email
**lookups:** eq, ilike, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: assignee__email
description: 'Filter for: assignee__email
**lookups:** eq, ilike, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract__id
description: 'Filter for: contract__id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract__id__exact
description: 'Filter for: contract__id__exact
**lookups:** eq'
in: query
required: false
deprecated: false
schema:
type: string
- name: created
description: 'Filter for: created
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**null:** MP-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace__name
description: 'Filter for: marketplace__name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product_id
description: 'Filter for: product_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sli.days
description: 'Filter for: sli.days
**lookups:** eq, ge, gt, le, lt
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: sli.zone
description: 'Filter for: sli.zone
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
- scheduled
- revoking
- revoked
- name: template
description: 'This filter is used for explicit negative select. For example,
select(-template). It will not return "template" object in the response.
Combining it together with select(-activation_key), i.e. doing select(-activation_key,-template),
may dramatically increase /requests API performance. Please consider using
those two negative selects if in your application you do not need to treat
neither "activation_key" field nor "template" object.
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: template.id
description: 'Filter for: template.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- purchase
- cancel
- change
- suspend
- resume
- adjustment
- renew
- name: updated
description: 'Filter for: updated
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_request_list_createRequest
description: 'Requests endpoints allows the creation of different kind of requests
to handle the life cycle
of Assets.'
tags:
- Assets
parameters: []
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/dp.AssetPurchaseRequest'
- $ref: '#/components/schemas/dp.AssetChangeRequest'
- $ref: '#/components/schemas/dp.AssetSuspendResumeCancelRequest'
discriminator:
propertyName: type
examples:
purchase:
summary: Purchase request
value:
type: purchase
asset:
product:
id: PRD-403-038-754
connection:
id: CT-1234-0000-1234
type: test
external_uid: 1c378bdd-9c8a-4566-be8a-bd90a51aa42a
external_id: '10005'
items:
- id: PRD-403-038-754-0001
quantity: 5
params:
- id: ordering_1
value: test
tiers:
customer:
name: Big Corp Inc
external_id: '76829'
external_uid: ac6d6da9-e628-495b-952c-c5c10a76f78d
tax_id: 24VR1XOQ1G
contact_info:
address_line1: Feeney Trace
address_line2: Margarete Pines
city: Baldwin
state: Alabama
postal_code: '36507'
country: US
contact:
first_name: Kadin
last_name: Reilly
email: user@email.com
phone_number:
country_code: '+1'
area_code: '201'
phone_number: '5550123'
extension: ''
tier1:
name: CB Demo Provider
external_id: '12'
external_uid: a6fbc2d5-891d-44df-8856-e78ed18edb38
tax_id: AA3R4D4A55
contact_info:
address_line1: Carley Village
address_line2: Bette Landing
city: Ahorn
state: Bavaria
postal_code: '96482'
country: DE
contact:
first_name: Noe
last_name: Treutel
email: beolars.bribbs+Noe_Treutel@gmail.com
phone_number:
country_code: '+49'
area_code: ''
phone_number: '1635554922'
extension: ''
marketplace:
id: MP-91673
change:
summary: Change request
value:
type: change
asset:
id: AS-2439-5446-5628
items:
- id: PRD-403-038-754-0001
quantity: 5
cancel:
summary: Cancel request
value:
type: cancel
asset:
id: AS-2439-5446-5628
description: ''
responses:
'201':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/requests/{id}:
get:
operationId: dp_request_detail_retrieveRequest
description: obtains a concrete request identified by it's id
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
put:
operationId: dp_request_detail_updateRequest
description: 'Updates parameters on the request, only value, structured_value
or value_error can
be modified'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
asset:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
structured_error:
type: object
properties:
message:
type: object
properties:
id:
type: string
external_id:
type: string
value:
type: string
context:
type: object
value_choices:
type: array
items:
type: string
title:
type: string
responses:
'200':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/requests/{id}/approve:
post:
operationId: dp_request_approve_postApproveRequest
description: 'This method approves a request that is in `Pending` status. No
further changes are
possible after it is moved to `Approved` status.
To use this method,
you must provide
either a `template_id` or an `activation_tile`. Note that `activation_tile`
will be deprecated
and `template_id` is the recommended way to handle texts, customizations,
and localization of
templates directly in the CloudBlue Connect platform.
You can also
set an
`effective_date` in ISO format, i.e. `2023-04-28 11:36:38.814429+00:00` to
specify when the
request was approved. You can also adjust the next billing date of the subscription
when
approving the request by providing `asset.billing.next_date`. Note that this
is only required
in rare cases and you should check with your distributor if it is supported
on their side.
CloudBlue Connect will stop generating automatic billing requests until this
date.'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
template_id:
type: string
activation_tile:
type: string
effective_date:
type: string
asset:
type: object
properties:
billing:
type: object
properties:
next_date:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/assign:
post:
operationId: dp_request_assign_postAssignRequest
description: Assigns a request to a given user
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
email:
type: string
format: email
oneOf:
- required:
- id
- required:
- email
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/confirm:
post:
operationId: dp_request_confirm_postConfirmRequest
description: 'Requests endpoints allows the creation of different kind of requests
to handle the life cycle
of Assets.'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/fail:
post:
operationId: dp_request_fail_postFailRequest
description: Fails a request, this is a terminal status
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
reason:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/inquire:
post:
operationId: dp_request_inquire_postInquireRequest
description: 'Moves the request to inquire state, allowing technical contact
to populate parameters
marked as error'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
template_id:
type: string
activation_tile:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/pend:
post:
operationId: dp_request_pend_postPendRequest
description: 'Sets status pending, only suitable when request is in status inquiring.
If you perform
HTTP request with method POST and ''code='' in HTTP request URL parameters
then the action require Subscription Request parameters to be specified.'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/purchase:
post:
operationId: dp_request_purchase_postPurchaseRequest
description: Applicable to draft requests to move it to pending status
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/render:
get:
operationId: dp_request_render_getRenderRequest
description: Render linked template to the request using the parameters from
the request
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
- name: Connect-Localization
in: header
description: 'This is an **optional** header. Providing this header will allow
you to receive localized result of this API. The system will fetch available
template translations from localization service under your account and will
provide translated rendered template. **Accepted values**: `AF, AR, AR-DZ,
AST, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, DSB, EL, EN, EN-AU, EN-GB,
EO, ES, ES-AR, ES-CO, ES-MX, ES-NI, ES-VE, ET, EU, FA, FI, FR, FY, GA, GD,
GL, HE, HI, HR, HSB, HU, HY, IA, ID, IG, IO, IS, IT, JA, KA, KAB, KK, KM,
KN, KO, KY, LB, LT, LV, MK, ML, MN, MR, MY, NB, NE, NL, NN, NO, OS, PA,
PL, PT, PT-BR, RO, RU, SK, SL, SQ, SR, SR-LATN, SV, SW, TA, TE, TG, TH,
TK, TR, TT, UDM, UK, UR, UZ, VI, ZH-CN, ZH-HANS, ZH-HANT, ZH-HK, ZH-MO,
ZH-MY, ZH-SG, ZH-TW.` As an alternative, you can also provide in this header
the exact translation id you would like to use, i.e. `TRN-1234-5678-9101`.
Such translation must exist under your account in localization service,
it may or may not be active.'
schema:
$ref: '#/components/headers/Connect-Localization'
responses:
'200':
description: ''
content:
text/markdown:
schema:
type: string
example: '
# Sample Activation Template
Activation template is used to share details of the **successful**
subscription creation with
the user. Once purchase request is approved, this template is used
to
generate user-visible notification.
This template uses **[Markdown](https://en.wikipedia.org/wiki/Markdown)**
syntax and allows
to use Parameters of the product which has scope ''Subscription''.
### Formatting
Markdown allows you to control various aspects of the document:
1. Text formatting like **bold** or *italic*
2. Images embedding
3. Lists
4. and more
### Parameters
You can refer to the Parameters using their ID, like in the following
example:
* The value of **Title of the Parameter A** is **PARAMETER A VALUE**
* The value of **Title of the Parameter B** is **PARAMETER B VALUE**
You can also embed pictures like the one below:

'
headers:
Connect-Localization:
description: This is an **optional** header. Locale id of the returned
data according to Connect Localization service configuration under
your account.
schema:
type: string
/requests/{id}/revoke:
post:
operationId: dp_request_revoke_postRevokeRequest
description: 'Requests endpoints allows the creation of different kind of requests
to handle the life cycle
of Assets.'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
reason:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/schedule:
post:
operationId: dp_request_schedule_postScheduleRequest
description: 'Requests endpoints allows the creation of different kind of requests
to handle the life cycle
of Assets.'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
planned_date:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/submit:
post:
operationId: dp_request_submit_postSubmitRequest
description: 'Requests endpoints allows the creation of different kind of requests
to handle the life cycle
of Assets.'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/unassign:
post:
operationId: dp_request_unassign_postUnassignRequest
description: Unassigns request from assigned user
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/requests/{id}/validate:
post:
operationId: dp_request_validate_postValidateRequest
description: 'Requests endpoints allows the creation of different kind of requests
to handle the life cycle
of Assets.'
tags:
- Assets
parameters:
- name: id
in: path
required: true
description: A unique value identifying this request.
schema:
type: string
requestBody:
description: Performs Real-Time Validation of this request.
content:
application/json:
schema:
type: object
properties:
asset:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_error:
type: object
properties:
message:
type: object
properties:
id:
type: string
external_id:
type: string
value:
type: string
context:
type: object
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- asset
- tier1
- tier2
value_choices:
type: array
items:
type: object
properties:
label:
type: string
value:
type: string
phase:
type: string
enum:
- fulfillment
- ordering
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
reconciliation:
type: boolean
shared:
type: string
enum:
- view
- edit
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
type:
type: string
enum:
- purchase
- change
- suspend
- resume
- cancel
note:
type: string
reason:
type: string
created:
type: string
format: datetime
updated:
type: string
format: datetime
effective_date:
type: string
format: datetime
answered:
type: boolean
assignee:
type: string
activation_key:
type: string
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
status:
type: string
enum:
- draft
- tiers_setup
- pending
- inquiring
- approved
- failed
previous_approved_request:
type: object
properties:
id:
type: string
asset:
type: object
properties:
id:
type: string
status:
type: string
enum:
- active
- new
- processing
- rejected
- suspended
- terminated
external_id:
type: string
external_uid:
type: string
product:
type: object
properties:
id:
type: string
icon:
type: string
name:
type: string
status:
type: string
enum:
- draft
- published
- endofsale
connection:
type: object
properties:
id:
type: string
provider:
type: object
properties:
id:
type: string
name:
type: string
vendor:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
enum:
- preview
- test
- production
hub:
type: object
properties:
id:
type: string
name:
type: string
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
updated:
type: object
properties:
at:
type: string
format: datetime
readOnly: true
items:
type: array
items:
type: object
properties:
id:
type: string
global_id:
type: string
mpn:
type: string
old_quantity:
type: string
quantity:
type: string
type:
type: string
display_name:
type: string
period:
type: string
item_type:
type: string
params:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_value:
type: object
oneOf:
- type: object
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
required:
- address_line1
- city
- state
- postal_code
- country
- type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
required:
- country_code
- area_code
- phone_number
- extension
value_choices:
type: array
items:
type: string
title:
type: string
tiers:
type: object
properties:
customer:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier1:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
tier2:
type: object
properties:
external_id:
type: string
external_uid:
type: string
name:
type: string
tax_id:
type: string
contact_info:
type: object
required:
- address_line1
- city
- postal_code
- country
- contact
properties:
address_line1:
type: string
address_line2:
type: string
city:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
contact:
type: object
required:
- first_name
- last_name
- email
- phone_number
properties:
first_name:
type: string
last_name:
type: string
email:
type: string
format: email
phone_number:
type: object
properties:
country_code:
type: string
area_code:
type: string
phone_number:
type: string
extension:
type: string
readOnly: true
readOnly: true
configuration:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- product
- item
- marketplace
- item_marketplace
phase:
type: string
enum:
- configuration
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
shared:
type: string
enum:
- view
- edit
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
updated:
type: object
properties:
at:
type: string
format: datetime
by:
type: object
properties:
id:
type: string
name:
type: string
readOnly: true
marketplace:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
contract:
type: object
properties:
id:
type: string
name:
type: string
description: ''
/tier/account-requests:
get:
operationId: dp_tier_account_requests_list_listTierAccountRequests
description: ''
tags:
- Customers
parameters:
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/dp.RQLContentRangeLimitOffsetPagination.offset'
- name: account.external_id
description: 'Filter for: account.external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.external_uid
description: 'Filter for: account.external_uid
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.hub.id
description: 'Filter for: account.hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true
**null:** HB-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.hub.name
description: 'Filter for: account.hub.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.id
description: 'Filter for: account.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.name
description: 'Filter for: account.name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.version
description: 'Filter for: account.version
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: integer
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- pending
- accepted
- ignored
- unsupported
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.TierAccountRequest'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_tier_account_requests_list_createTierAccountRequest
description: ''
tags:
- Customers
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountRequestCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountRequestCreate'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/tier/account-requests/{id}:
get:
operationId: dp_tier_account_requests_detail_retrieveTierAccountRequest
description: ''
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Account Request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountRequest'
description: ''
/tier/account-requests/{id}/accept:
post:
operationId: dp_tier_account_requests_accept_postAcceptTierAccountRequest
description: ''
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Account Request.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountRequest'
description: ''
/tier/account-requests/{id}/ignore:
post:
operationId: dp_tier_account_requests_ignore_postIgnoreTierAccountRequest
description: ''
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Account Request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
reason:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountRequest'
description: ''
/tier/accounts:
get:
operationId: dp_tier_accounts_list_listTierAccountDetails
description: ''
tags:
- Customers
parameters:
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
- name: contact_info
description: 'Filter for: contact_info
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: contact_info.contact.email
description: 'Filter for: contact_info.contact.email
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: db
description: 'Filter for: db
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- EU
- US
- JP
- AU
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by
description: 'Filter for: events.created.by
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.by
description: 'Filter for: events.updated.by
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: external_uid
description: 'Filter for: external_uid
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.id
description: 'Filter for: hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true
**null:** HB-0000-0000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: hub.name
description: 'Filter for: hub.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.id
description: 'Filter for: owner.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.name
description: 'Filter for: owner.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: parent.id
description: 'Filter for: parent.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: parent.name
description: 'Filter for: parent.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: parent.parent.id
description: 'Filter for: parent.parent.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: scopes
description: 'Filter for: scopes
**lookups:** eq, like, ilike, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: tax_id
description: 'Filter for: tax_id
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- customer
- reseller
- name: version
description: 'Filter for: version
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.TierAccountDetail'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_tier_accounts_list_createTierAccountCreate
description: ''
tags:
- Customers
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountCreate'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/tier/accounts/{account_id}/versions:
get:
operationId: dp_tier_account_versions_list_listTierAccountVersions
description: ''
tags:
- Customers
parameters:
- name: account_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.limit'
- $ref: '#/components/parameters/dp.LimitOffsetContentRangePagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.TierAccountVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/tier/accounts/{account_id}/versions/{version}:
get:
operationId: dp_tier_account_versions_detail_retrieveTierAccountVersion
description: ''
tags:
- Customers
parameters:
- name: account_id
in: path
required: true
description: ''
schema:
type: string
- name: version
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountVersion'
description: ''
/tier/accounts/{id}:
get:
operationId: dp_tier_accounts_detail_retrieveTierAccountDetail
description: Get base object or redirect to object version.
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountDetail'
description: ''
put:
operationId: dp_tier_accounts_detail_updateTierAccountUpdate
description: ''
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierAccountUpdate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
delete:
operationId: dp_tier_accounts_detail_destroyTierAccountDetail
description: ''
tags:
- Customers
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/tier/config-requests:
get:
operationId: dp_tier_config_request_list_listTierConfigRequests
description: ''
tags:
- Settings
parameters:
- $ref: '#/components/parameters/dp.RQL1000Pagination.limit'
- $ref: '#/components/parameters/dp.RQL1000Pagination.offset'
- name: search
required: false
in: query
description: A search term.
schema:
type: string
- name: assignee.id
description: 'Filter for: assignee.id
**lookups:** eq, ilike, null, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: assignee.name
description: 'Filter for: assignee.name
**lookups:** eq, ilike, null, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: assignee__id
description: 'Filter for: assignee__id
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration
description: 'Filter for: configuration
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.account.external_id
description: 'Filter for: configuration.account.external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.account.external_uid
description: 'Filter for: configuration.account.external_uid
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.account.hub.id
description: 'Filter for: configuration.account.hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.account.hub.name
description: 'Filter for: configuration.account.hub.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.account.id
description: 'Filter for: configuration.account.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.configuration
description: 'Filter for: configuration.configuration
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.connection.type
description: 'Filter for: configuration.connection.type
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: configuration.contract.id
description: 'Filter for: configuration.contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.id
description: 'Filter for: configuration.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.marketplace.id
description: 'Filter for: configuration.marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.marketplace.name
description: 'Filter for: configuration.marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.params
description: 'Filter for: configuration.params
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.product.capabilities
description: "This filter is used for explicit select. For example, select(configuration.product.capabilities).\
\ It will return additionally product capabilities in the response.\n\n\
**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.product.id
description: 'Filter for: configuration.product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.product.name
description: 'Filter for: configuration.product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration.tier_level
description: 'Filter for: configuration.tier_level
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
enum:
- 1
- 2
- name: configuration__account__external_uid
description: 'Filter for: configuration__account__external_uid
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration__account__id
description: 'Filter for: configuration__account__id
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration__id
description: 'Filter for: configuration__id
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration__product__id
description: 'Filter for: configuration__product__id
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration__product__name
description: 'Filter for: configuration__product__name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration__tier_level
description: 'Filter for: configuration__tier_level
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
enum:
- 1
- 2
- name: created
description: 'Filter for: created
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: environment
description: 'Filter for: environment
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.id
description: 'Filter for: params.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.value
description: 'Filter for: params.value
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: sli.days
description: 'Filter for: sli.days
**lookups:** eq, ge, gt, le, lt
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: sli.zone
description: 'Filter for: sli.zone
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- tiers_setup
- pending
- inquiring
- approved
- failed
- draft
- name: template.id
description: 'Filter for: template.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tiers
description: 'Filter for: tiers
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- setup
- update
- adjustment
- name: unassigned
description: 'Filter for: unassigned
**lookups:** ne, null'
in: query
required: false
deprecated: false
schema:
type: string
- name: updated
description: 'Filter for: updated
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.TierConfigRequestRead'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: dp_tier_config_request_list_createTierConfigRequest
description: ''
tags:
- Settings
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestCreate'
description: ''
'400':
$ref: '#/components/responses/dp.create_400'
/tier/config-requests/{id}:
get:
operationId: dp_tier_config_request_detail_retrieveTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
- name: search
required: false
in: query
description: A search term.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestRead'
description: ''
put:
operationId: dp_tier_config_request_detail_updateTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
- name: search
required: false
in: query
description: A search term.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestCreate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestCreate'
description: ''
'400':
$ref: '#/components/responses/dp.update_400'
/tier/config-requests/{id}/approve:
post:
operationId: dp_tier_config_request_approve_postApproveTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
template:
type: object
properties:
id:
type: string
effective_date:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
template:
type: object
properties:
id:
type: string
representation:
type: string
effective_date:
type: string
/tier/config-requests/{id}/assign:
post:
operationId: dp_tier_config_request_assign_postAssignTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
id:
type: string
email:
type: string
format: email
oneOf:
- required:
- id
- required:
- email
responses:
'204':
description: ''
/tier/config-requests/{id}/fail:
post:
operationId: dp_tier_config_request_fail_postFailTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
reason:
type: string
responses:
'204':
description: ''
/tier/config-requests/{id}/inquire:
post:
operationId: dp_tier_config_request_inquire_postInquireTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
responses:
'204':
description: ''
/tier/config-requests/{id}/pend:
post:
operationId: dp_tier_config_request_pend_postPendTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
responses:
'204':
description: ''
/tier/config-requests/{id}/render:
get:
operationId: dp_tier_config_request_render_getRenderTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
- name: Connect-Localization
in: header
description: 'This is an **optional** header. Providing this header will allow
you to receive localized result of this API. The system will fetch available
template translations from localization service under your account and will
provide translated rendered template. **Accepted values**: `AF, AR, AR-DZ,
AST, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, DSB, EL, EN, EN-AU, EN-GB,
EO, ES, ES-AR, ES-CO, ES-MX, ES-NI, ES-VE, ET, EU, FA, FI, FR, FY, GA, GD,
GL, HE, HI, HR, HSB, HU, HY, IA, ID, IG, IO, IS, IT, JA, KA, KAB, KK, KM,
KN, KO, KY, LB, LT, LV, MK, ML, MN, MR, MY, NB, NE, NL, NN, NO, OS, PA,
PL, PT, PT-BR, RO, RU, SK, SL, SQ, SR, SR-LATN, SV, SW, TA, TE, TG, TH,
TK, TR, TT, UDM, UK, UR, UZ, VI, ZH-CN, ZH-HANS, ZH-HANT, ZH-HK, ZH-MO,
ZH-MY, ZH-SG, ZH-TW.` As an alternative, you can also provide in this header
the exact translation id you would like to use, i.e. `TRN-1234-5678-9101`.
Such translation must exist under your account in localization service,
it may or may not be active.'
schema:
$ref: '#/components/headers/Connect-Localization'
responses:
'200':
description: ''
content:
text/markdown:
schema:
type: string
example: '
# Sample Activation Template
Activation template is used to share details of the **successful**
subscription creation with
the user. Once purchase request is approved, this template is used
to
generate user-visible notification.
This template uses **[Markdown](https://en.wikipedia.org/wiki/Markdown)**
syntax and allows
to use Parameters of the product which has scope ''Subscription''.
### Formatting
Markdown allows you to control various aspects of the document:
1. Text formatting like **bold** or *italic*
2. Images embedding
3. Lists
4. and more
### Parameters
You can refer to the Parameters using their ID, like in the following
example:
* The value of **Title of the Parameter A** is **PARAMETER A VALUE**
* The value of **Title of the Parameter B** is **PARAMETER B VALUE**
You can also embed pictures like the one below:

'
headers:
Connect-Localization:
description: This is an **optional** header. Locale id of the returned
data according to Connect Localization service configuration under
your account.
schema:
type: string
/tier/config-requests/{id}/submit:
post:
operationId: dp_tier_config_request_submit_postSubmitTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestRead'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestRead'
description: ''
/tier/config-requests/{id}/unassign:
post:
operationId: dp_tier_config_request_unassign_postUnassignTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
responses:
'204':
description: ''
/tier/config-requests/{id}/validate:
post:
operationId: dp_tier_config_request_validate_postValidateTierConfigRequest
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration Request.
schema:
type: string
requestBody:
description: Performs Real-Time Validation of this Tier Configuration Request.
content:
application/json:
schema:
type: object
properties:
params:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
value:
type: string
value_error:
type: string
structured_error:
type: object
properties:
message:
type: object
properties:
id:
type: string
external_id:
type: string
value:
type: string
context:
type: object
type:
type: string
enum:
- text
- dropdown
- password
- email
- checkbox
- subdomain
- domain
- phone
- url
- choice
scope:
type: string
enum:
- asset
- tier1
- tier2
value_choices:
type: array
items:
type: object
properties:
label:
type: string
value:
type: string
phase:
type: string
enum:
- fulfillment
- ordering
constraints:
type: object
properties:
required:
type: boolean
hidden:
type: boolean
readonly:
type: boolean
unique:
type: boolean
reconciliation:
type: boolean
shared:
type: string
enum:
- view
- edit
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigRequestRead'
description: ''
/tier/configs:
get:
operationId: dp_tier_config_list_listTierConfigurations
description: ''
tags:
- Settings
parameters:
- $ref: '#/components/parameters/dp.RQL1000Pagination.limit'
- $ref: '#/components/parameters/dp.RQL1000Pagination.offset'
- name: account.company_name
description: 'Filter for: account.company_name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.external_id
description: 'Filter for: account.external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.external_uid
description: 'Filter for: account.external_uid
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: account.id
description: 'Filter for: account.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: configuration
description: 'Filter for: configuration
**lookups:** '
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.id
description: 'Filter for: connection.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: connection.product_version_type
description: 'Filter for: connection.product_version_type
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- public
- staging
- name: connection.type
description: 'Filter for: connection.type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- production
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true
**null:** CRD-00000-00000-00000, null()'
in: query
required: false
deprecated: false
schema:
type: string
- name: created
description: 'Filter for: created
**lookups:** ge, le
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.id
description: 'Filter for: params.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: params.value
description: 'Filter for: params.value
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, in
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- active
- processing
- name: template.id
description: 'Filter for: template.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tier_level
description: 'Filter for: tier_level
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
enum:
- 1
- 2
- name: updated
description: 'Filter for: updated
**lookups:** ge, le
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dp.TierConfiguration'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/tier/configs/{id}:
get:
operationId: dp_tier_config_detail_retrieveTierConfiguration
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/dp.TierConfigurationDetail'
description: ''
/tier/configs/{id}/render:
get:
operationId: dp_tier_config_render_getRenderTierConfiguration
description: ''
tags:
- Settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Tier Configuration.
schema:
type: string
- name: Connect-Localization
in: header
description: 'This is an **optional** header. Providing this header will allow
you to receive localized result of this API. The system will fetch available
template translations from localization service under your account and will
provide translated rendered template. **Accepted values**: `AF, AR, AR-DZ,
AST, AZ, BE, BG, BN, BR, BS, CA, CS, CY, DA, DE, DSB, EL, EN, EN-AU, EN-GB,
EO, ES, ES-AR, ES-CO, ES-MX, ES-NI, ES-VE, ET, EU, FA, FI, FR, FY, GA, GD,
GL, HE, HI, HR, HSB, HU, HY, IA, ID, IG, IO, IS, IT, JA, KA, KAB, KK, KM,
KN, KO, KY, LB, LT, LV, MK, ML, MN, MR, MY, NB, NE, NL, NN, NO, OS, PA,
PL, PT, PT-BR, RO, RU, SK, SL, SQ, SR, SR-LATN, SV, SW, TA, TE, TG, TH,
TK, TR, TT, UDM, UK, UR, UZ, VI, ZH-CN, ZH-HANS, ZH-HANT, ZH-HK, ZH-MO,
ZH-MY, ZH-SG, ZH-TW.` As an alternative, you can also provide in this header
the exact translation id you would like to use, i.e. `TRN-1234-5678-9101`.
Such translation must exist under your account in localization service,
it may or may not be active.'
schema:
$ref: '#/components/headers/Connect-Localization'
responses:
'200':
description: ''
content:
text/markdown:
schema:
type: string
example: '
# Sample Activation Template
Activation template is used to share details of the **successful**
subscription creation with
the user. Once purchase request is approved, this template is used
to
generate user-visible notification.
This template uses **[Markdown](https://en.wikipedia.org/wiki/Markdown)**
syntax and allows
to use Parameters of the product which has scope ''Subscription''.
### Formatting
Markdown allows you to control various aspects of the document:
1. Text formatting like **bold** or *italic*
2. Images embedding
3. Lists
4. and more
### Parameters
You can refer to the Parameters using their ID, like in the following
example:
* The value of **Title of the Parameter A** is **PARAMETER A VALUE**
* The value of **Title of the Parameter B** is **PARAMETER B VALUE**
You can also embed pictures like the one below:

'
headers:
Connect-Localization:
description: This is an **optional** header. Locale id of the returned
data according to Connect Localization service configuration under
your account.
schema:
type: string
/assets/{asset_pk}/usage/aggregates:
get:
operationId: usage_usagerecordaggregate_list_listUsageRecordAggregates
description: View class for Usage Aggregate API
tags:
- Usage Reporting
parameters:
- name: asset_pk
in: path
required: true
description: ''
schema:
type: string
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: asset.external_uid
description: 'Filter for: asset.external_uid
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.id
description: 'Filter for: asset.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.id
description: 'Filter for: item.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.local_id
description: 'Filter for: item.local_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.type
description: 'Filter for: item.type
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Reservation
- PPU
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.UsageRecordAggregate'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/products/{product_pk}/usage/rules:
get:
operationId: usage_product_rules_list_listUsageItemRules
description: ''
tags:
- Usage Reporting
parameters:
- name: product_pk
in: path
required: true
description: ''
schema:
type: string
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: action
description: 'Filter for: action
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- accept
- reject
- manual
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.id
description: 'Filter for: item.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.name
description: 'Filter for: item.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: rule
description: 'Filter for: rule
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- record
- file
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- active
- deleted
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.UsageItemRule'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
post:
operationId: usage_product_rules_list_createUsageItemRule
description: ''
tags:
- Usage Reporting
parameters:
- name: product_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
item:
type: object
properties:
id:
type: string
action:
type: string
rule:
type: string
status:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageItemRule'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/products/{product_pk}/usage/rules/{id}:
get:
operationId: usage_product_rules_detail_retrieveUsageItemRule
description: ''
tags:
- Usage Reporting
parameters:
- name: product_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Usage Item Rule.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageItemRule'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
put:
operationId: usage_product_rules_detail_updateUsageItemRule
description: ''
tags:
- Usage Reporting
parameters:
- name: product_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Usage Item Rule.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
item:
type: object
properties:
id:
type: string
action:
type: string
rule:
type: string
status:
type: string
gravity:
type: object
properties:
after:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageItemRule'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
delete:
operationId: usage_product_rules_detail_destroyUsageItemRule
description: ''
tags:
- Usage Reporting
parameters:
- name: product_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this Usage Item Rule.
schema:
type: string
responses:
'204':
description: ''
/usage/aggregates:
get:
operationId: usage_usage_record_aggregate_list_listUsageRecordAggregates
description: View class for Usage Aggregate API
tags:
- Usage Reporting
parameters:
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: asset.external_uid
description: 'Filter for: asset.external_uid
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.id
description: 'Filter for: asset.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.id
description: 'Filter for: item.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.local_id
description: 'Filter for: item.local_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.type
description: 'Filter for: item.type
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Reservation
- PPU
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.UsageRecordAggregate'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/chunks:
get:
operationId: usage_part_usage_file_list_listPartUsageFiles
description: ''
tags:
- Usage Reporting
parameters:
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: binding.hub.id
description: 'Filter for: binding.hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider.id
description: 'Filter for: provider.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- ready
- closed
- failed
- name: usagefile.id
description: 'Filter for: usagefile.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.PartUsageFile'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/chunks/{id}:
get:
operationId: usage_part_usage_file_detail_retrievePartUsageFile
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File Chunk.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.PartUsageFile'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
put:
operationId: usage_part_usage_file_detail_updatePartUsageFile
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File Chunk.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
external_id:
type: string
required:
- external_id
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.PartUsageFile'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/chunks/{id}/close:
post:
operationId: usage_part_usage_file_close_part_usage_file_postClose_part_usage_filePartUsageFile
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File Chunk.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
external_billing_id:
type: string
external_billing_note:
type: string
required:
- external_billing_id
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.PartUsageFile'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/chunks/{id}/download:
get:
operationId: usage_part_usage_file_download_getDownloadPartUsageFile
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File Chunk.
schema:
type: string
responses:
'200':
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
type: string
format: binary
description: ''
/usage/chunks/{id}/regenerate:
post:
operationId: usage_part_usage_file_regenerate_part_usage_file_postRegenerate_part_usage_filePartUsageFile
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File Chunk.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.PartUsageFile'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files:
get:
operationId: usage_usage_file_list_listUsageFiles
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: contract.id
description: 'Filter for: contract.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: contract.name
description: 'Filter for: contract.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: created.at
description: 'Filter for: created.at
**lookups:** ge, gt, le, lt
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: distribution_contract_id
description: 'Filter for: distribution_contract_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: environment
description: 'Filter for: environment
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- test
- preview
- production
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.id
description: 'Filter for: marketplace.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace.name
description: 'Filter for: marketplace.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: marketplace_id
description: 'Filter for: marketplace_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product_id
description: 'Filter for: product_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider.id
description: 'Filter for: provider.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider.name
description: 'Filter for: provider.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: provider_id
description: 'Filter for: provider_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: schema
description: 'Filter for: schema
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- tr
- pr
- qt
- cr
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- uploading
- uploaded
- invalid
- processing
- ready
- rejected
- pending
- accepted
- closed
- deleted
- name: vendor.id
description: 'Filter for: vendor.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: vendor.name
description: 'Filter for: vendor.name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: vendor_id
description: 'Filter for: vendor_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.UsageFileList'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
post:
operationId: usage_usage_file_list_createUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description:
type: string
note:
type: string
period:
type: object
properties:
from:
type: string
format: date
to:
type: string
format: date
currency:
type: string
product:
type: object
properties:
id:
type: string
contract:
type: object
properties:
id:
type: string
external_id:
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileCreate'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{file_pk}/categories:
get:
operationId: usage_categories_list_listCategories
description: ''
tags:
- Usage Reporting
parameters:
- name: file_pk
in: path
required: true
description: ''
schema:
type: string
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.Categories'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}:
get:
operationId: usage_usage_file_detail_retrieveUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
put:
operationId: usage_usage_file_detail_updateUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
description:
type: string
note:
type: string
period:
type: object
properties:
from:
type: string
format: date
to:
type: string
format: date
currency:
type: string
external_id:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileUpdate'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/accept:
post:
operationId: usage_usage_file_accept_usage_file_postAccept_usage_fileUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
acceptance_note:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/approve-all:
put:
operationId: usage_usage_file_approve_all_record_putApprove_all_recordUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/close:
post:
operationId: usage_usage_file_close_usage_file_postClose_usage_fileUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/delete:
post:
operationId: usage_usage_file_delete_usage_file_postDelete_usage_fileUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/reconciliation:
post:
operationId: usage_usage_file_upload_file_provider_postUpload_file_providerUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
recon_file:
type: string
format: binary
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/reject:
post:
operationId: usage_usage_file_reject_usage_file_postReject_usage_fileUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
rejection_note:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/reprocess:
post:
operationId: usage_usage_file_reprocess_processed_file_postReprocess_processed_fileUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/submit:
post:
operationId: usage_usage_file_submit_usage_file_postSubmit_usage_fileUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/files/{id}/upload:
post:
operationId: usage_usage_file_upload_usage_file_postUpload_usage_fileUsageFile
description: 'UsageFile collection contains APIs which can used used to create
Usage report, upload normalized file
and other actions available for vendors and providers.'
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage File.
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
usage_file:
type: string
format: binary
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageFileDetail'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/products/{id}/template:
get:
operationId: usage_products_get_product_template_file_getGet_product_template_fileProduct
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
template_link:
type: string
description: Download normalized template file. This file can be used to
populate usage record info and then upload for usage reporting.
/usage/reconciliations:
get:
operationId: usage_reconciliation_list_listReconciliations
description: ''
tags:
- Usage Reporting
parameters:
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: binding.hub.id
description: 'Filter for: binding.hub.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: partusagefile.id
description: 'Filter for: partusagefile.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: partusagefile.provider.id
description: 'Filter for: partusagefile.provider.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: usagefile.id
description: 'Filter for: usagefile.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.Reconciliation'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
post:
operationId: usage_reconciliation_list_createReconciliation
description: ''
tags:
- Usage Reporting
parameters: []
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
recon_file:
type: string
format: binary
upload_note:
type: string
required:
- recon_file
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.Reconciliation'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/reconciliations/{id}:
get:
operationId: usage_reconciliation_detail_retrieveReconciliation
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Reconciliation.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.Reconciliation'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/reconciliations/{id}/processedfile:
get:
operationId: usage_reconciliation_get_processed_getGet_processedReconciliation
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Reconciliation.
schema:
type: string
responses:
'200':
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
type: string
format: binary
description: ''
/usage/reconciliations/{id}/uploadedfile:
get:
operationId: usage_reconciliation_get_uploaded_getGet_uploadedReconciliation
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Reconciliation.
schema:
type: string
responses:
'200':
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
type: string
format: binary
description: ''
/usage/records:
get:
operationId: usage_usage_records_list_listUsageRecords
description: ''
tags:
- Usage Reporting
parameters:
- name: Content-Range
in: header
description: RQL RFC2616 limit offset pagination.
schema:
$ref: '#/components/headers/Content-Range'
- $ref: '#/components/parameters/usage.RQL1000Pagination.limit'
- $ref: '#/components/parameters/usage.RQL1000Pagination.offset'
- name: asset.external_id
description: 'Filter for: asset.external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.external_uid
description: 'Filter for: asset.external_uid
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset.id
description: 'Filter for: asset.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset_external_id
description: 'Filter for: asset_external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset_external_uid
description: 'Filter for: asset_external_uid
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: asset_id
description: 'Filter for: asset_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: created_time
description: 'Filter for: created_time
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: end_date
description: 'Filter for: end_date
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: hub.id
description: 'Filter for: hub.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.id
description: 'Filter for: item.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: item_id
description: 'Filter for: item_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: part_usage_file__hub__id
description: 'Filter for: part_usage_file__hub__id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product_id
description: 'Filter for: product_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: start_date
description: 'Filter for: start_date
**lookups:** eq, ne, ge, gt, le, lt, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- valid
- invalid
- approved
- rejected
- closed
- name: usage_file
description: 'Filter for: usage_file
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: usage_start_time
description: 'Filter for: usage_start_time
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: usagefile.id
description: 'Filter for: usagefile.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: usagefile.schema
description: 'Filter for: usagefile.schema
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- tr
- pr
- qt
- cr
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/usage.UsageRecord'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/records/close-records:
post:
operationId: usage_usage_records_close_usage_record_bulk_list_postClose_usage_record_bulk_listUsageRecord
description: ''
tags:
- Usage Reporting
parameters: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
external_billing_id:
type: string
external_billing_note:
type: string
responses:
'206':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
error_details:
type: string
error_codes:
type: string
status:
type: string
enum:
- valid
- invalid
- approved
- rejected
- closed
description: ''
/usage/records/{id}:
get:
operationId: usage_usage_records_detail_retrieveUsageRecord
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage Record.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageRecord'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
put:
operationId: usage_usage_records_detail_updateUsageRecord
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage Record.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- valid
- invalid
- approved
- rejected
- closed
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageRecord'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/usage/records/{id}/close:
post:
operationId: usage_usage_records_close_usage_record_postClose_usage_recordUsageRecord
description: ''
tags:
- Usage Reporting
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Usage Record.
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
external_billing_id:
type: string
external_billing_note:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/usage.UsageRecord'
description: ''
'400':
$ref: '#/components/responses/usage.any_400'
/notifications/email/send:
post:
operationId: ns_email_send_postSendEmailSend
description: ''
tags:
- Extensions
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
to:
type: array
items:
type: string
format: email
subject:
type: string
content:
type: string
rule:
type: object
properties:
id:
type: string
required:
- id
context:
type: object
oneOf:
- required:
- to
- subject
- content
- required:
- to
- rule
- context
description: ''
responses:
'200':
content:
application/json:
schema:
type: object
properties:
result:
type: string
description: ''
'400':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/notifications/subscriptions:
get:
operationId: ns_subscriptions_list_listAccountNotifications
description: ''
tags:
- Subscriptions
parameters:
- $ref: '#/components/parameters/ns.RQL1000Pagination.limit'
- $ref: '#/components/parameters/ns.RQL1000Pagination.offset'
- name: event.name
description: 'Filter for: event.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ns.AccountNotification'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
/notifications/subscriptions/-/rules/-/settings:
get:
operationId: ns_settings_list_listAccountSettings
description: ''
tags:
- Notification settings
parameters:
- $ref: '#/components/parameters/ns.RQL1000Pagination.limit'
- $ref: '#/components/parameters/ns.RQL1000Pagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ns.AccountSetting'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
put:
operationId: ns_settings_list_putBulk_updateAccountSetting
description: ''
tags:
- Notification settings
parameters: []
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
value:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.AccountSetting'
description: ''
/notifications/subscriptions/-/rules/-/settings/{id}:
put:
operationId: ns_settings_detail_updateAccountSetting
description: ''
tags:
- Notification settings
parameters:
- name: id
in: path
required: true
description: A unique value identifying this account setting.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ns.AccountSetting'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.AccountSetting'
description: ''
'400':
$ref: '#/components/responses/ns.update_400'
/notifications/subscriptions/{account_notification_id}/rules:
get:
operationId: ns_notification_rules_list_listNotificationRules
description: ''
tags:
- Notification Rules
parameters:
- name: account_notification_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ns.NotificationRule'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: ns_notification_rules_list_createNotificationRule
description: ''
tags:
- Notification Rules
parameters:
- name: account_notification_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
description: ''
'400':
$ref: '#/components/responses/ns.create_400'
/notifications/subscriptions/{account_notification_id}/rules/{id}:
get:
operationId: ns_notification_rules_detail_retrieveNotificationRule
description: ''
tags:
- Notification Rules
parameters:
- name: account_notification_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this notification rule.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
description: ''
put:
operationId: ns_notification_rules_detail_updateNotificationRule
description: ''
tags:
- Notification Rules
parameters:
- name: account_notification_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this notification rule.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
description: ''
'400':
$ref: '#/components/responses/ns.update_400'
delete:
operationId: ns_notification_rules_detail_destroyNotificationRule
description: ''
tags:
- Notification Rules
parameters:
- name: account_notification_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this notification rule.
schema:
type: string
responses:
'204':
description: ''
/notifications/subscriptions/{account_notification_id}/rules/{id}/preview:
post:
operationId: ns_notification_rules_preview_postPreviewNotificationRule
description: ''
tags:
- Notification Rules
parameters:
- name: account_notification_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this notification rule.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
description: ''
/notifications/subscriptions/{account_notification_id}/rules/{id}/send-test:
post:
operationId: ns_notification_rules_send_test_postSend_testNotificationRule
description: ''
tags:
- Notification Rules
parameters:
- name: account_notification_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this notification rule.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.NotificationRule'
description: ''
/notifications/subscriptions/{id}:
get:
operationId: ns_subscriptions_detail_retrieveAccountNotification
description: ''
tags:
- Subscriptions
parameters:
- name: id
in: path
required: true
description: A unique value identifying this account notification.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.AccountNotification'
description: ''
put:
operationId: ns_subscriptions_detail_updateAccountNotification
description: ''
tags:
- Subscriptions
parameters:
- name: id
in: path
required: true
description: A unique value identifying this account notification.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ns.AccountNotification'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.AccountNotification'
description: ''
'400':
$ref: '#/components/responses/ns.update_400'
/notifications/subscriptions/{id}/preview-context:
get:
operationId: ns_subscriptions_preview_context_getPreview_contextAccountNotification
description: ''
tags:
- Subscriptions
parameters:
- name: id
in: path
required: true
description: A unique value identifying this account notification.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.AccountNotification'
description: ''
/notifications/webhooks:
get:
operationId: ns_webhook_list_listWebhooks
description: ''
tags:
- Extensions
parameters:
- $ref: '#/components/parameters/ns.RQL1000Pagination.limit'
- $ref: '#/components/parameters/ns.RQL1000Pagination.offset'
- name: active
description: 'Filter for: active
**lookups:** eq, ne
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: description
description: 'Filter for: description
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: label
description: 'Filter for: label
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- event
- validator
- change_validator
- change_inquiring_validator
- inquiring_validator
- draft_tcr_t1_val
- draft_tcr_t2_val
- tcr_setup_t1_inq_val
- tcr_setup_t2_inq_val
- tcr_update_t1_validator
- tcr_update_t2_validator
- tcr_update_t1_inq_val
- tcr_update_t2_inq_val
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ns.Webhook'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
post:
operationId: ns_webhook_list_createWebhook
description: ''
tags:
- Extensions
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
enum:
- inquiring_validator
- tcr_update_t2_validator
- tcr_update_t1_validator
- event
- tcr_update_t2_inq_val
- tcr_setup_t2_inq_val
- draft_tcr_t2_val
- tcr_update_t1_inq_val
- change_inquiring_validator
- change_validator
- tcr_setup_t1_inq_val
- draft_tcr_t1_val
- validator
object_class:
type: string
enum:
- billing_request
- tier_config_request
- usage_file
- fulfillment_request
- listing_request
- tier_account_request
label:
type: string
product_id:
type: string
external_url:
type: string
jwt_secret:
type: string
active:
type: boolean
description:
type: string
http_method:
type: string
enum:
- POST
data:
type: object
headers:
type: object
required:
- object_class
- label
- product_id
- description
- external_url
- jwt_secret
- active
- http_method
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.Webhook'
description: ''
'400':
$ref: '#/components/responses/ns.create_400'
/notifications/webhooks/{id}:
get:
operationId: ns_webhook_detail_retrieveWebhook
description: ''
tags:
- Extensions
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.Webhook'
description: ''
put:
operationId: ns_webhook_detail_updateWebhook
description: ''
tags:
- Extensions
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
enum:
- inquiring_validator
- tcr_update_t2_validator
- tcr_update_t1_validator
- event
- tcr_update_t2_inq_val
- tcr_setup_t2_inq_val
- draft_tcr_t2_val
- tcr_update_t1_inq_val
- change_inquiring_validator
- change_validator
- tcr_setup_t1_inq_val
- draft_tcr_t1_val
- validator
object_class:
type: string
enum:
- billing_request
- tier_config_request
- usage_file
- fulfillment_request
- listing_request
- tier_account_request
label:
type: string
product_id:
type: string
external_url:
type: string
jwt_secret:
type: string
active:
type: boolean
description:
type: string
http_method:
type: string
enum:
- POST
data:
type: object
headers:
type: object
required:
- object_class
- label
- product_id
- description
- external_url
- jwt_secret
- active
- http_method
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ns.Webhook'
description: ''
'400':
$ref: '#/components/responses/ns.update_400'
delete:
operationId: ns_webhook_detail_destroyWebhook
description: ''
tags:
- Extensions
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/notifications/webhooks/{id}/trigger:
post:
operationId: ns_webhook_trigger_postTriggerWebhook
description: ''
tags:
- Extensions
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
description: ''
/pricing/lists:
get:
operationId: pricing_lists_list_listPriceLists
description: '# Create and manage PriceLists.
First PriceListVersion is created with PriceList creation.
PricePoints are created for each Item of each PriceList Product.'
tags:
- Pricing
parameters:
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.offset'
- name: currency
description: 'Filter for: currency
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UYW
- UZS
- VED
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.id
description: 'Filter for: owner.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: owner.name
description: 'Filter for: owner.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.listings
description: 'Filter for: stats.listings
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.products
description: 'Filter for: stats.products
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- scheduled
- active
- terminated
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/pricing.PriceList'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/pricing.any_400'
post:
operationId: pricing_lists_list_createPriceList
description: '# Create and manage PriceLists.
First PriceListVersion is created with PriceList creation.
PricePoints are created for each Item of each PriceList Product.'
tags:
- Pricing
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceList'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceList'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/lists/{id}:
get:
operationId: pricing_lists_detail_retrievePriceList
description: '# Create and manage PriceLists.
First PriceListVersion is created with PriceList creation.
PricePoints are created for each Item of each PriceList Product.'
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceList'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
put:
operationId: pricing_lists_detail_updatePriceList
description: '# Create and manage PriceLists.
First PriceListVersion is created with PriceList creation.
PricePoints are created for each Item of each PriceList Product.'
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List.
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
name:
type: string
maxLength: 512
description:
type: string
maxLength: 2048
attributes:
items:
type: object
minItems: 1
type: array
uniqueItems: true
description: PriceList attributes (columns). This is a array of
objects. Each object must contain 'name' properties. Property
'description' is optional. Property 'id' is allowed for update
only. Property 'name' must match pattern '^(Price|Suggested T0
Price|Suggested T1 Price|Suggested T2 Price|v\..{1:98})$'. At
least one attribute must be specified. If specified 'name' and/or
'description' properties for predefined attributes then they will
be redefined. Custom attributes 'name' property must start with
'v.'. Attributes order is equal to XLSX representation column
order.
type: object
description: PriceList representation. Field 'stats.listings' is accessed
only by Vendor.
required:
- name
- description
- attributes
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceList'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
delete:
operationId: pricing_lists_detail_destroyPriceList
description: '# Create and manage PriceLists.
First PriceListVersion is created with PriceList creation.
PricePoints are created for each Item of each PriceList Product.'
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List.
schema:
type: string
responses:
'204':
description: ''
/pricing/lists/{id}/terminate:
post:
operationId: pricing_lists_terminate_postTerminatePriceList
description: 'Terminate PriceList. Active PriceListVersions of this PriceList
will be set to ''expired'' status.
Scheduled one will be set to ''draft'' status.'
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List.
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.Action'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions:
get:
operationId: pricing_versions_list_listPriceListVersions
description: '# Create and manage PriceListVersions.
PricePoints will be created for each Item of each PriceList Product.
PriceListVersion XLSX representation will be fixed for Provider after schedule/activate.
After one of these actions any changes will not affect on XLSX representation
for Provider.
For bulk update XLSX file download is needed to set:
* HTTP Content-Type header: application/vnd.openxmlformats-officedocument.spreadsheetml.template
* or add format=''xlsx'' param to query string (?format=xlsx)'
tags:
- Pricing
parameters:
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.currency
description: 'Filter for: pricelist.currency
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLE
- SLL
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UYW
- UZS
- VED
- VES
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XTS
- XUA
- XXX
- YER
- ZAR
- ZMW
- ZWL
- name: pricelist.id
description: 'Filter for: pricelist.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.name
description: 'Filter for: pricelist.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.owner.id
description: 'Filter for: pricelist.owner.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.owner.name
description: 'Filter for: pricelist.owner.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.product.id
description: 'Filter for: pricelist.product.id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.product.name
description: 'Filter for: pricelist.product.name
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: pricelist.stats.listings
description: 'Filter for: pricelist.stats.listings
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: pricelist.stats.products
description: 'Filter for: pricelist.stats.products
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: start_at
description: 'Filter for: start_at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- processing
- draft
- scheduled
- active
- expired
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/pricing.PriceListVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/pricing.any_400'
post:
operationId: pricing_versions_list_createPriceListVersion
description: '# Create and manage PriceListVersions.
PricePoints will be created for each Item of each PriceList Product.
PriceListVersion XLSX representation will be fixed for Provider after schedule/activate.
After one of these actions any changes will not affect on XLSX representation
for Provider.
For bulk update XLSX file download is needed to set:
* HTTP Content-Type header: application/vnd.openxmlformats-officedocument.spreadsheetml.template
* or add format=''xlsx'' param to query string (?format=xlsx)'
tags:
- Pricing
parameters: []
requestBody:
content:
application/json:
schema:
properties:
description:
type: string
maxLength: 2048
base:
$ref: '#/components/schemas/pricing.PriceListVersionReference'
description: Base PriceListVersion (PricePoints are got from that
PriceListVersion).
start_at:
type: string
format: date-time
description: Time when this PriceListVersion is activated (in case
of scheduling activation in future). PriceListVersions are being
activated at begin of specified hour.
type: object
description: PriceListVersion representation.
required:
- description
- base
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceListVersion'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions/{id}:
get:
operationId: pricing_versions_detail_retrievePriceListVersion
description: '# Create and manage PriceListVersions.
PricePoints will be created for each Item of each PriceList Product.
PriceListVersion XLSX representation will be fixed for Provider after schedule/activate.
After one of these actions any changes will not affect on XLSX representation
for Provider.
For bulk update XLSX file download is needed to set:
* HTTP Content-Type header: application/vnd.openxmlformats-officedocument.spreadsheetml.template
* or add format=''xlsx'' param to query string (?format=xlsx)'
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List Version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceListVersion'
application/vnd.openxmlformats-officedocument.spreadsheetml.template:
schema:
type: string
format: binary
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
put:
operationId: pricing_versions_detail_updatePriceListVersion
description: '# Create and manage PriceListVersions.
PricePoints will be created for each Item of each PriceList Product.
PriceListVersion XLSX representation will be fixed for Provider after schedule/activate.
After one of these actions any changes will not affect on XLSX representation
for Provider.
For bulk update XLSX file download is needed to set:
* HTTP Content-Type header: application/vnd.openxmlformats-officedocument.spreadsheetml.template
* or add format=''xlsx'' param to query string (?format=xlsx)'
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List Version.
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
description:
type: string
maxLength: 2048
start_at:
type: string
format: date-time
description: Time when this PriceListVersion is activated (in case
of scheduling activation in future). PriceListVersions are being
activated at begin of specified hour.
type: object
description: PriceListVersion representation.
required:
- description
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceListVersion'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
delete:
operationId: pricing_versions_detail_destroyPriceListVersion
description: '# Create and manage PriceListVersions.
PricePoints will be created for each Item of each PriceList Product.
PriceListVersion XLSX representation will be fixed for Provider after schedule/activate.
After one of these actions any changes will not affect on XLSX representation
for Provider.
For bulk update XLSX file download is needed to set:
* HTTP Content-Type header: application/vnd.openxmlformats-officedocument.spreadsheetml.template
* or add format=''xlsx'' param to query string (?format=xlsx)'
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List Version.
schema:
type: string
responses:
'204':
description: ''
/pricing/versions/{id}/activate:
post:
operationId: pricing_versions_activate_postActivatePriceListVersion
description: Immediately activate PriceListVersion. Previous active one will
be set to 'expired' status.
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List Version.
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.Action'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions/{id}/cancel:
post:
operationId: pricing_versions_cancel_postCancelPriceListVersion
description: Returns scheduled PriceListVersion into 'draft' status.
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List Version.
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.Action'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions/{id}/schedule:
post:
operationId: pricing_versions_schedule_postSchedulePriceListVersion
description: Schedule PriceListVersion activation on specified in property 'start_at'
time.
tags:
- Pricing
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Price List Version.
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
start_at:
type: string
format: date-time
description: Time when this PriceListVersion is activated (in case
of scheduling activation in future). PriceListVersions are being
activated at begin of specified hour.
type: object
description: PriceListVersion representation.
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceListVersion'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions/{version_pk}/adjustments:
get:
operationId: pricing_versions_adjustments_list_listPriceAdjustments
description: '# Upload and manage PriceAdjustments.
This is PricePoint bulk update ability through downloading
current PriceListVersion XLSX representation and uploading XLSX file.'
tags:
- Pricing
parameters:
- name: version_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- processing
- success
- partial
- failed
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/pricing.PriceAdjustment'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/pricing.any_400'
post:
operationId: pricing_versions_adjustments_list_createPriceAdjustment
description: '# Upload and manage PriceAdjustments.
This is PricePoint bulk update ability through downloading
current PriceListVersion XLSX representation and uploading XLSX file.'
tags:
- Pricing
parameters:
- name: version_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
properties:
uploaded_file:
type: string
format: binary
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceAdjustment'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions/{version_pk}/adjustments/{id}:
get:
operationId: pricing_versions_adjustments_detail_retrievePriceAdjustment
description: '# Upload and manage PriceAdjustments.
This is PricePoint bulk update ability through downloading
current PriceListVersion XLSX representation and uploading XLSX file.'
tags:
- Pricing
parameters:
- name: version_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PriceAdjustment'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions/{version_pk}/points:
get:
operationId: pricing_versions_points_list_listPricePoints
description: '# View and manage PricePoints.
These are set of price attribute values for each Item.
PricePoints are automatically created for each PriceListVersion.'
tags:
- Pricing
parameters:
- name: version_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/pricing.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.display_name
description: 'Filter for: item.display_name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.global_id
description: 'Filter for: item.global_id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.product.id
description: 'Filter for: item.product.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: item.product.name
description: 'Filter for: item.product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- filled
- empty
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/pricing.PricePoint'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/pricing.any_400'
/pricing/versions/{version_pk}/points/{id}:
get:
operationId: pricing_versions_points_detail_retrievePricePoint
description: '# View and manage PricePoints.
These are set of price attribute values for each Item.
PricePoints are automatically created for each PriceListVersion.'
tags:
- Pricing
parameters:
- name: version_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PricePoint'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
put:
operationId: pricing_versions_points_detail_updatePricePoint
description: '# View and manage PricePoints.
These are set of price attribute values for each Item.
PricePoints are automatically created for each PriceListVersion.'
tags:
- Pricing
parameters:
- name: version_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
attributes:
type: object
type: object
description: PricePoint representation.
required:
- attributes
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/pricing.PricePoint'
description: ''
'400':
$ref: '#/components/responses/pricing.any_400'
/accounts:
get:
operationId: auth_accounts_list_listAccounts
description: ''
tags:
- Accounts
parameters:
- $ref: '#/components/parameters/auth.RQL1000Pagination.limit'
- $ref: '#/components/parameters/auth.RQL1000Pagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: public
description: 'Filter for: public
**lookups:** eq, ne, null'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: role
description: 'Filter for: role
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Vendor
- Distributor
- Reseller
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Vendor
- Provider
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.Account'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_accounts_list_createAccountCreate
description: ''
tags:
- Accounts
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountCreate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/accounts/{account_pk}/groups:
get:
operationId: auth_groups_list_listGroups
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: description
description: 'Filter for: description
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: permissions.id
description: 'Filter for: permissions.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: permissions.object.id
description: 'Filter for: permissions.object.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.users
description: 'Filter for: stats.users
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.Group'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_groups_list_createGroupCreate
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.GroupCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.GroupCreate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/accounts/{account_pk}/groups/{group_pk}/permissions:
get:
operationId: auth_group_permissions_list_listGroupPermissions
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: group_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: object.id
description: 'Filter for: object.id
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
object:
type: object
properties:
id:
type: string
events:
type: object
properties:
granted:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_group_permissions_list_createPermissionMerge
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: group_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.PermissionMerge'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.PermissionMerge'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_group_permissions_list_destroyPermissionMerge
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: group_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/accounts/{account_pk}/groups/{group_pk}/users:
get:
operationId: auth_group_users_list_listGroupUsers
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: group_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: email
description: 'Filter for: email
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.added.at
description: 'Filter for: events.added.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
external_id:
type: string
email:
type: string
format: email
active:
type: boolean
notifications:
type: boolean
announcements:
type: boolean
blocklisted:
type: boolean
region:
type: string
timeformat:
type: string
timezone:
type: string
idp:
$ref: '#/components/schemas/auth.IDPReference'
domain:
$ref: '#/components/schemas/auth.DomainUser'
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: date-time
signed:
type: object
properties:
at:
type: string
format: date-time
invited:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
activated:
type: object
properties:
at:
type: string
format: date-time
added:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
status:
type: string
activation_code:
type: string
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_group_users_list_createGroupUserChangeMembership
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: group_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.GroupUserChangeMembership'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.GroupUserChangeMembership'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_group_users_list_destroyGroupUserChangeMembership
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: group_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/accounts/{account_pk}/groups/{pk}:
get:
operationId: auth_groups_detail_retrieveGroup
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Group'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_groups_detail_updateGroupUpdate
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.GroupUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.GroupUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_groups_detail_destroyGroup
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/accounts/{account_pk}/media:
get:
operationId: auth_account_media_list_listSerializerCl
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- image
- video
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_account_media_list_createSerializerCls
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/accounts/{account_pk}/media/{pk}:
get:
operationId: auth_account_media_detail_retrieveSerializerCls
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_account_media_detail_updateSerializerCls
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_account_media_detail_destroySerializerCls
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/accounts/{account_pk}/users:
get:
operationId: auth_account_users_list_listAccountUsers
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQL1000Pagination.limit'
- $ref: '#/components/parameters/auth.RQL1000Pagination.offset'
- name: domain.auth.enforce
description: 'Filter for: domain.auth.enforce
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: domain.auth.idp.id
description: 'Filter for: domain.auth.idp.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: domain.id
description: 'Filter for: domain.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: email
description: 'Filter for: email
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.activated.at
description: 'Filter for: events.activated.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.invited.at
description: 'Filter for: events.invited.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.signed.at
description: 'Filter for: events.signed.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: groups.id
description: 'Filter for: groups.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: groups.name
description: 'Filter for: groups.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: idp.id
description: 'Filter for: idp.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: permissions
description: "Filter for: permissions\n\n**lookups:** \n\n**default:** *hidden*"
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: tags.id
description: 'Filter for: tags.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tags.name
description: 'Filter for: tags.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
external_id:
type: string
email:
type: string
format: email
active:
type: boolean
notifications:
type: boolean
announcements:
type: boolean
blocklisted:
type: boolean
region:
type: string
timeformat:
type: string
timezone:
type: string
idp:
$ref: '#/components/schemas/auth.IDPReference'
domain:
$ref: '#/components/schemas/auth.DomainUser'
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: date-time
signed:
type: object
properties:
at:
type: string
format: date-time
invited:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
activated:
type: object
properties:
at:
type: string
format: date-time
status:
type: string
activation_code:
type: string
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_account_users_list_createAccountUserCreate
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountUserCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountUserCreate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/accounts/{account_pk}/users/{pk}:
get:
operationId: auth_account_users_detail_retrieveAccountUser
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
external_id:
type: string
email:
type: string
format: email
active:
type: boolean
notifications:
type: boolean
announcements:
type: boolean
blocklisted:
type: boolean
region:
type: string
timeformat:
type: string
timezone:
type: string
idp:
$ref: '#/components/schemas/auth.IDPReference'
domain:
$ref: '#/components/schemas/auth.DomainUser'
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: date-time
signed:
type: object
properties:
at:
type: string
format: date-time
invited:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
activated:
type: object
properties:
at:
type: string
format: date-time
status:
type: string
activation_code:
type: string
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_account_users_detail_updateAccountUserUpdate
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountUserUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountUserUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_account_users_detail_destroyAccountUser
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/accounts/{account_pk}/users/{pk}/activate:
post:
operationId: auth_account_users_activate_postActivateAccountUser
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
external_id:
type: string
email:
type: string
format: email
active:
type: boolean
notifications:
type: boolean
announcements:
type: boolean
blocklisted:
type: boolean
region:
type: string
timeformat:
type: string
timezone:
type: string
idp:
$ref: '#/components/schemas/auth.IDPReference'
domain:
$ref: '#/components/schemas/auth.DomainUser'
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: date-time
signed:
type: object
properties:
at:
type: string
format: date-time
invited:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
activated:
type: object
properties:
at:
type: string
format: date-time
status:
type: string
activation_code:
type: string
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/accounts/{account_pk}/users/{pk}/reinvite:
post:
operationId: auth_account_users_reinvite_postReinviteAccountUser
description: ''
tags:
- Accounts
parameters:
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
external_id:
type: string
email:
type: string
format: email
active:
type: boolean
notifications:
type: boolean
announcements:
type: boolean
blocklisted:
type: boolean
region:
type: string
timeformat:
type: string
timezone:
type: string
idp:
$ref: '#/components/schemas/auth.IDPReference'
domain:
$ref: '#/components/schemas/auth.DomainUser'
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: date-time
signed:
type: object
properties:
at:
type: string
format: date-time
invited:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
activated:
type: object
properties:
at:
type: string
format: date-time
status:
type: string
activation_code:
type: string
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/accounts/{pk}:
get:
operationId: auth_accounts_detail_retrieveAccount
description: ''
tags:
- Accounts
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Account'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_accounts_detail_updateAccountUpdate
description: ''
tags:
- Accounts
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.AccountUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_accounts_detail_destroyAccount
description: ''
tags:
- Accounts
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/acl/{acl}/rules:
get:
operationId: auth_acl_rules_list_listAclRules
description: ''
tags:
- ACL
parameters:
- name: acl
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: action
description: 'Filter for: action
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- allow
- deny
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: value
description: 'Filter for: value
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.ACLRule'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_acl_rules_list_createACLRule
description: ''
tags:
- ACL
parameters:
- name: acl
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ACLRule'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ACLRule'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_acl_rules_list_destroyIdWrite
description: ''
tags:
- ACL
parameters:
- name: acl
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/acl/{acl}/rules/{pk}:
get:
operationId: auth_acl_rules_detail_retrieveACLRule
description: ''
tags:
- ACL
parameters:
- name: acl
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ACLRule'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_acl_rules_detail_updateACLRule
description: ''
tags:
- ACL
parameters:
- name: acl
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ACLRule'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ACLRule'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_acl_rules_detail_deleteDestroy_objectACLRule
description: ''
tags:
- ACL
parameters:
- name: acl
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/auth/context:
get:
operationId: auth_context_list_listContextWrites
description: ''
tags:
- Auth
parameters: []
responses:
'200':
headers:
Set-Cookie:
schema:
type: string
description: Cookie for User Authentication
content:
application/json:
schema:
type: object
properties:
account:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
user:
type: object
properties:
id:
type: string
name:
type: string
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
post:
operationId: auth_context_list_createContextWrite
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
account:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
user:
type: object
properties:
id:
type: string
name:
type: string
description: ''
responses:
'201':
content:
application/json:
schema:
type: object
properties:
account:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
user:
type: object
properties:
id:
type: string
name:
type: string
description: ''
'400':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/auth/eaas/{ext_id}/login:
get:
operationId: auth_eaas_login_list_listEaaSLoginViewSets
description: ''
tags:
- Auth
parameters:
- name: ext_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items: {}
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_eaas_login_list_createEaaSLoginViewSet
description: ''
tags:
- Auth
parameters:
- name: ext_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'201':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/auth/login:
post:
operationId: auth_login_list_createAuthLogin
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
password:
type: string
recaptcha:
type: string
responses:
'201':
headers:
Set-Cookie:
schema:
type: string
description: Cookie for User Authentication
content:
application/json:
schema:
type: object
properties:
account:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
user:
type: object
properties:
id:
type: string
name:
type: string
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/auth/logout:
post:
operationId: auth_logout_list_createAuthLogout
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema:
type: object
properties: {}
headers:
Set-Cookie:
schema:
type: string
description: User Authentication Cookie is deleted
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/auth/password/change:
post:
operationId: auth_password_change_list_createPasswordChange
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.PasswordChange'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.PasswordChange'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/auth/password/restore:
post:
operationId: auth_password_restore_list_createAuthPasswordRestore
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
recaptcha:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/auth/password/set:
post:
operationId: auth_password_set_list_createAuthPasswordSet
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
password:
type: string
recaptcha:
type: string
responses:
'201':
headers:
Set-Cookie:
schema:
type: string
description: Cookie for User Authentication
content:
application/json:
schema:
type: object
properties:
account:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
user:
type: object
properties:
id:
type: string
name:
type: string
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/auth/recaptcha:
get:
operationId: auth_recaptcha_list_listAuthRecaptchas
description: ''
tags:
- Auth
parameters: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
sitekey:
type: string
description: ''
/auth/tokens:
get:
operationId: auth_tokens_list_listTokens
description: ''
tags:
- Extensions
parameters:
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: extension.id
description: 'Filter for: extension.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: extension.name
description: 'Filter for: extension.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: permissions.id
description: 'Filter for: permissions.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: permissions.object.id
description: 'Filter for: permissions.object.id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- pending
- active
- inactive
- deleted
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.Token'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_tokens_list_createTokenWrite
description: ''
tags:
- Extensions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.TokenWrite'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.TokenWrite'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/auth/tokens/{pk}:
get:
operationId: auth_tokens_detail_retrieveToken
description: ''
tags:
- Extensions
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Token'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_tokens_detail_updateTokenUpdate
description: ''
tags:
- Extensions
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.TokenUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.TokenUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_tokens_detail_destroyToken
description: ''
tags:
- Extensions
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/auth/tokens/{pk}/activate:
post:
operationId: auth_tokens_activate_postActivateToken
description: ''
tags:
- Extensions
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Token'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/auth/tokens/{pk}/deactivate:
post:
operationId: auth_tokens_deactivate_postDeactivateToken
description: ''
tags:
- Extensions
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Token'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/auth/tokens/{token_pk}/permissions:
get:
operationId: auth_token_permissions_list_listTokenPermissions
description: ''
tags:
- Extensions
parameters:
- name: token_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: object.id
description: 'Filter for: object.id
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
object:
type: object
properties:
id:
type: string
events:
type: object
properties:
granted:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_token_permissions_list_createPermissionMerge
description: ''
tags:
- Extensions
parameters:
- name: token_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.PermissionMerge'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.PermissionMerge'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_token_permissions_list_destroyPermissionMerge
description: ''
tags:
- Extensions
parameters:
- name: token_pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/auth/user/check:
post:
operationId: auth_user_check_list_createAuthUserCheck
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
email:
type: string
recaptcha:
type: string
description: ''
responses:
'200':
content:
application/json:
schema:
type: object
properties:
idp:
type: object
properties:
id:
type: string
name:
type: string
type:
type: string
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
'404':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/dictionary/extensions/categories:
get:
operationId: auth_extension_categories_list_listExtensionCategories
description: ''
tags:
- Extensions
parameters:
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.ExtensionCategory'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
/dictionary/extensions/categories/{pk}:
get:
operationId: auth_extension_categories_detail_retrieveExtensionCategory
description: ''
tags:
- Extensions
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ExtensionCategory'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/domains:
get:
operationId: branding_domains_list_listDomains
description: ''
tags:
- Domains
parameters:
- $ref: '#/components/parameters/branding.RQL1000Pagination.limit'
- $ref: '#/components/parameters/branding.RQL1000Pagination.offset'
- name: checks.cname_record.status
description: 'Filter for: checks.cname_record.status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- verified
- failed
- legacy
- name: checks.http_status.status
description: 'Filter for: checks.http_status.status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- verified
- failed
- name: description
description: 'Filter for: description
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: domain
description: 'Filter for: domain
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.by.id
description: 'Filter for: events.updated.by.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.by.name
description: 'Filter for: events.updated.by.name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: portal.id
description: 'Filter for: portal.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- built_in
- custom
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/branding.Domain'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/branding.any_400'
post:
operationId: branding_domains_list_createDomain
description: ''
tags:
- Domains
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/branding.Domain'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/branding.Domain'
description: ''
'400':
$ref: '#/components/responses/branding.any_400'
/domains/{domain_pk}/users:
get:
operationId: auth_domain_users_list_listUsers
description: ''
tags:
- Domains
parameters:
- name: domain_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: email
description: 'Filter for: email
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: idp.id
description: 'Filter for: idp.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.User'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
/domains/{domain_pk}/users/{pk}:
get:
operationId: auth_domain_users_detail_retrieveUser
description: ''
tags:
- Domains
parameters:
- name: domain_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.User'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_domain_users_detail_updateDomainUserUpdate
description: ''
tags:
- Domains
parameters:
- name: domain_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.DomainUserUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.DomainUserUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/domains/{pk}:
get:
operationId: auth_domains_detail_retrieveDomainAccount
description: ''
tags:
- Domains
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.DomainAccount'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_domains_detail_updateDomainUpdate
description: ''
tags:
- Domains
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.DomainUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.DomainUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_domains_detail_destroyDomainAccount
description: ''
tags:
- Domains
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/domains/{pk}/verify:
post:
operationId: auth_domains_verify_postVerifyDomainAccount
description: ''
tags:
- Domains
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.DomainAccount'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/extensions:
get:
operationId: auth_extensions_list_listExtensions
description: ''
tags:
- Extensions
parameters:
- $ref: '#/components/parameters/auth.RQL1000Pagination.limit'
- $ref: '#/components/parameters/auth.RQL1000Pagination.offset'
- name: categories.id
description: 'Filter for: categories.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: constraints.account.tokens
description: 'Filter for: constraints.account.tokens
**lookups:** eq, ne, ge, gt, le, lt, in, out'
in: query
required: false
deprecated: false
schema:
type: integer
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: featured
description: 'Filter for: featured
**lookups:** eq, ne
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: industries.id
description: 'Filter for: industries.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: portal
description: 'Filter for: portal
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- any
- provider
- vendor
- name: priority
description: 'Filter for: priority
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- published
- unrestricted
- publishing
- unpublishing
- name: system
description: 'Filter for: system
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.Extension'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_extensions_list_createExtensionCreate
description: ''
tags:
- Extensions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ExtensionCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ExtensionCreate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/extensions/{extension_id}/media:
get:
operationId: auth_extension_media_list_listSerializerCl
description: ''
tags:
- Extensions
parameters:
- name: extension_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- image
- video
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_extension_media_list_createSerializerCls
description: ''
tags:
- Extensions
parameters:
- name: extension_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/extensions/{extension_id}/media/{pk}:
get:
operationId: auth_extension_media_detail_retrieveSerializerCls
description: ''
tags:
- Extensions
parameters:
- name: extension_id
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_extension_media_detail_updateSerializerCls
description: ''
tags:
- Extensions
parameters:
- name: extension_id
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.SerializerCls'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_extension_media_detail_destroySerializerCls
description: ''
tags:
- Extensions
parameters:
- name: extension_id
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/extensions/{id}:
get:
operationId: auth_extensions_detail_retrieveExtension
description: ''
tags:
- Extensions
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Extension'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_extensions_detail_updateExtensionUpdate
description: ''
tags:
- Extensions
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ExtensionUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.ExtensionUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_extensions_detail_destroyExtension
description: ''
tags:
- Extensions
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/idps:
get:
operationId: auth_idps_list_listIdpAccounts
description: ''
tags:
- Auth
parameters:
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.IDPAccount'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_idps_list_createIDPCreate
description: ''
tags:
- Auth
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.IDPCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.IDPCreate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/idps/{idp_id}:
get:
operationId: auth_idps_detail_retrieveIDPAccount
description: ''
tags:
- Auth
parameters:
- name: idp_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.IDPAccount'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_idps_detail_updateIDPUpdate
description: ''
tags:
- Auth
parameters:
- name: idp_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.IDPUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.IDPUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_idps_detail_destroyIDPAccount
description: ''
tags:
- Auth
parameters:
- name: idp_id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/industries:
get:
operationId: auth_industries_list_listIndustries
description: ''
tags:
- General Collections
parameters:
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.Industry'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
/industries/{pk}:
get:
operationId: auth_industries_detail_retrieveIndustry
description: ''
tags:
- General Collections
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Industry'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/modules:
get:
operationId: auth_modules_list_listModules
description: ''
tags:
- General Collections
parameters:
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.Module'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
/modules/MD-0001/settings:
get:
operationId: auth_modules_account_id_settings_list_listAccountModuleSettingsViewSets
description: ''
tags:
- General Collections
parameters: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
domain:
type: object
properties:
verification:
type: object
properties:
name:
type: string
type:
type: string
prefix:
type: string
acl:
type: object
properties:
domain:
type: string
enum:
- allow
- deny
data:
type: object
properties:
residency:
type: string
mfa:
type: object
properties:
policy:
type: string
enum:
- optional
- suggested
- required
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/modules/account/settings:
get:
operationId: auth_modules_account_alias_settings_list_listAccountModuleSettingsViewSets
description: ''
tags:
- General Collections
parameters: []
responses:
'200':
content:
application/json:
schema:
type: object
properties:
domain:
type: object
properties:
verification:
type: object
properties:
name:
type: string
type:
type: string
prefix:
type: string
acl:
type: object
properties:
domain:
type: string
enum:
- allow
- deny
data:
type: object
properties:
residency:
type: string
mfa:
type: object
properties:
policy:
type: string
enum:
- optional
- suggested
- required
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/modules/{pk}:
get:
operationId: auth_modules_detail_retrieveModule
description: ''
tags:
- General Collections
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.Module'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/users:
get:
operationId: auth_users_list_listAccountUsers
description: ''
tags:
- User
parameters:
- $ref: '#/components/parameters/auth.RQL1000Pagination.limit'
- $ref: '#/components/parameters/auth.RQL1000Pagination.offset'
- name: domain.auth.enforce
description: 'Filter for: domain.auth.enforce
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: domain.auth.idp.id
description: 'Filter for: domain.auth.idp.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: domain.id
description: 'Filter for: domain.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: email
description: 'Filter for: email
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.activated.at
description: 'Filter for: events.activated.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.invited.at
description: 'Filter for: events.invited.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.signed.at
description: 'Filter for: events.signed.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: groups.id
description: 'Filter for: groups.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: groups.name
description: 'Filter for: groups.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: idp.id
description: 'Filter for: idp.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: permissions
description: 'Filter for: permissions
**lookups:** eq, ne, like, ilike, in, out
**default:** *hidden*'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: tags.id
description: 'Filter for: tags.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: tags.name
description: 'Filter for: tags.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
external_id:
type: string
email:
type: string
format: email
active:
type: boolean
notifications:
type: boolean
announcements:
type: boolean
blocklisted:
type: boolean
region:
type: string
timeformat:
type: string
timezone:
type: string
idp:
$ref: '#/components/schemas/auth.IDPReference'
domain:
$ref: '#/components/schemas/auth.DomainUser'
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: date-time
signed:
type: object
properties:
at:
type: string
format: date-time
invited:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
activated:
type: object
properties:
at:
type: string
format: date-time
status:
type: string
activation_code:
type: string
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_users_list_createUserCreate
description: ''
tags:
- User
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserCreate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/users/{pk}:
get:
operationId: auth_users_detail_retrieveAccountUser
description: ''
tags:
- User
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: object
properties:
id:
type: string
name:
type: string
icon:
type: string
external_id:
type: string
email:
type: string
format: email
active:
type: boolean
notifications:
type: boolean
announcements:
type: boolean
blocklisted:
type: boolean
region:
type: string
timeformat:
type: string
timezone:
type: string
idp:
$ref: '#/components/schemas/auth.IDPReference'
domain:
$ref: '#/components/schemas/auth.DomainUser'
events:
type: object
properties:
created:
type: object
properties:
at:
type: string
format: date-time
signed:
type: object
properties:
at:
type: string
format: date-time
invited:
type: object
properties:
at:
type: string
format: date-time
by:
type: object
properties:
id:
type: string
name:
type: string
activated:
type: object
properties:
at:
type: string
format: date-time
status:
type: string
activation_code:
type: string
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_users_detail_updateUserUpdate
description: ''
tags:
- User
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema: {}
responses:
'200':
content:
application/json:
schema: {}
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_users_detail_destroyAccountUser
description: ''
tags:
- User
parameters:
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/users/{user_pk}/accounts:
get:
operationId: auth_user_accounts_list_listUserAccounts
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQL1000Pagination.limit'
- $ref: '#/components/parameters/auth.RQL1000Pagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: external_id
description: 'Filter for: external_id
**lookups:** eq, ne, like, ilike, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**search:** true
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: public
description: 'Filter for: public
**lookups:** eq, ne, null'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: role
description: 'Filter for: role
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Vendor
- Distributor
- Reseller
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- Vendor
- Provider
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.UserAccount'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
/users/{user_pk}/accounts/{account_pk}/settings/{pk}:
get:
operationId: auth_user_account_settings_detail_retrieveMenuSetting
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
'404':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
put:
operationId: auth_user_account_settings_detail_updateMenuSetting
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: account_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
content:
application/json:
schema:
type: array
items:
type: object
description: ''
'401':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
'403':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
'404':
content:
application/json:
schema:
type: object
properties:
error_code:
type: string
errors:
type: array
items:
type: string
description: ''
/users/{user_pk}/accounts/{pk}:
get:
operationId: auth_user_accounts_detail_retrieveUserAccount
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserAccount'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/users/{user_pk}/contacts:
get:
operationId: auth_user_contacts_list_listUserContacts
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: tags.id
description: 'Filter for: tags.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.UserContact'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
post:
operationId: auth_user_contacts_list_createUserContactCreate
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserContactCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserContactCreate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/users/{user_pk}/contacts/{pk}:
get:
operationId: auth_user_contacts_detail_retrieveUserContact
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserContact'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
put:
operationId: auth_user_contacts_detail_updateUserContactUpdate
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserContactUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserContactUpdate'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
delete:
operationId: auth_user_contacts_detail_destroyUserContact
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/users/{user_pk}/sessions:
get:
operationId: auth_user_sessions_list_listUserSessions
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/auth.RQLContentRangeLimitOffsetPagination.offset'
- name: current
description: 'Filter for: current
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- active
- deleted
- expired
- terminated
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/auth.UserSession'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/auth.any_400'
/users/{user_pk}/sessions/{pk}:
get:
operationId: auth_user_sessions_detail_retrieveUserSession
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserSession'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/users/{user_pk}/sessions/{pk}/terminate:
post:
operationId: auth_user_sessions_terminate_postTerminateUserSession
description: ''
tags:
- User
parameters:
- name: user_pk
in: path
required: true
description: ''
schema:
type: string
- name: pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserSession'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/auth.UserSession'
description: ''
'400':
$ref: '#/components/responses/auth.any_400'
/reporting/reports:
get:
operationId: reporting_reports_list_listReports
description: Get the reports available in the collection.
tags:
- Reports
parameters:
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.started.at
description: 'Filter for: events.started.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.terminated.at
description: 'Filter for: events.terminated.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: schedule.id
description: 'Filter for: schedule.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- pending
- deploying
- running
- succeeded
- failed
- name: template.id
description: 'Filter for: template.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: template.name
description: 'Filter for: template.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: template.type
description: 'Filter for: template.type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- system
- custom
- name: timeout
description: 'Filter for: timeout
**lookups:** eq, ne
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: boolean
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/reporting.Report'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/reporting.any_400'
post:
operationId: reporting_reports_list_createReportCreate
description: Create a new report and execute it.
tags:
- Reports
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.Report'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/reports/{id}:
get:
operationId: reporting_reports_detail_retrieveReport
description: Get a concrete report given it's id.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.Report'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
delete:
operationId: reporting_reports_detail_destroyReport
description: Delete a concrete report execution given it's id.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/reporting/reports/{id}/download:
get:
operationId: reporting_reports_download_getDownloadReport
description: 'Download the result of the report execution, by default an Excel
file.
Report download is only possible for successfully executed reports.'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
description: ''
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
type: string
format: binary
/reporting/reports/{id}/fail:
post:
operationId: reporting_reports_fail_postFailReportFail
description: 'Mark the report as failed, method only available to concrete execution
run.
**WARNING! The update of the status of a given report to failed
is only available to CloudBlue Connect Reports Runner.
External actors cannot transition the report to failed.**.
If `block` is set to `True`, the templates associated with the report will
be blocked as well.'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportFail'
responses:
'204':
description: ''
/reporting/reports/{id}/progress:
post:
operationId: reporting_reports_progress_postProgressReportUpdateProgress
description: 'Update report execution progress. Available only for concrete
execution and
while is not in a final state, in other words must be either running or deploying.
**WARNING! The update of the generation progress of a given report
is only available to CloudBlue Connect Reports Runner.
External actors cannot update the generation progress of a report.**.'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportUpdateProgress'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.Report'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/reports/{id}/upload:
post:
operationId: reporting_reports_upload_postUploadReportFileUpload
description: 'Upload report execution result (i.e. Excel file) for a given report
id.
**WARNING! The upload of a generated report is only available to CloudBlue
Connect Reports
Runner. External actors cannot upload a generated report.**.
Report upload is only possible for running report, after upload action the
execution is marked as successful.'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
schema:
type: string
format: binary
responses:
'204':
description: ''
/reporting/repositories:
get:
operationId: reporting_repositories_list_listReportsRepositories
description: Get the report repositories available in the collection.
tags:
- Reports
parameters:
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: repository_type
description: 'Filter for: repository_type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- system
- custom
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- configuring
- ready
- failed
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/reporting.ReportsRepository'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/reporting.any_400'
post:
operationId: reporting_repositories_list_createReportsRepositoryCreate
description: 'Create new reports repository resource.
The newly created reports repository will be set to the
`configuring` status till the validation of the contained templates is finalized.
An asynchronous task will be started to validate and configure the report
templates contained
within the reports git repository.'
tags:
- Reports
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportsRepositoryCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportsRepository'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/repositories/tags:
post:
operationId: reporting_repositories_tags_postAnonymous_tagsRepositoryTagsRequest
description: 'Get a list of tags created on the remote git
repository received as input.'
tags:
- Reports
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.RepositoryTagsRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.RepositoryTags'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/repositories/{id}:
get:
operationId: reporting_repositories_detail_retrieveReportsRepository
description: Get a concrete report repository object given it's id.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportsRepository'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
put:
operationId: reporting_repositories_detail_updateReportsRepositoryCreate
description: 'Updates a reports repository resource.
The report templates associated to the reports repository
that is being updated will be blocked and no longer can be
used to generate reports. The reports repository will be
switched to the `configuring` status till the validation of the contained
templates is finalized
and an asynchronous task will be started to validate and configure the report
templates contained within the reports git repository based
on the updated git information.'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportsRepositoryCreate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportsRepository'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
delete:
operationId: reporting_repositories_detail_destroyReportsRepository
description: 'Delete repository object based on the provided repository id.
Repositories in `configuring` status cannot be deleted.'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/reporting/repositories/{id}/tags:
get:
operationId: reporting_repositories_existing_tags_getTagsReportsRepository
description: 'Get a list of tags created on the remote git repository.
Unlike `/tags` endpoint, this one returns tags not for the repository received
as
an input, but for the repository previously saved in the system.'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.RepositoryTags'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/schedules:
get:
operationId: reporting_schedules_list_listReportSchedules
description: Get the report schedules available in the collection.
tags:
- Reports
parameters:
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.last_execution.at
description: 'Filter for: events.last_execution.at
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.next_execution.at
description: 'Filter for: events.next_execution.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- enabled
- disabled
- name: template.id
description: 'Filter for: template.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: template.local_id
description: 'Filter for: template.local_id
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: template.name
description: 'Filter for: template.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: template.type
description: 'Filter for: template.type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- system
- custom
- name: trigger.frequency
description: 'Filter for: trigger.frequency
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- daily
- weekly
- monthly
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/reporting.ReportSchedule'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/reporting.any_400'
post:
operationId: reporting_schedules_list_createReportScheduleCreate
description: Create a new schedule object for reports.
tags:
- Reports
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportScheduleCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportScheduleCreate'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/schedules/{id}:
get:
operationId: reporting_schedules_detail_retrieveReportSchedule
description: Get a concrete report schedule given it's id.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportSchedule'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
put:
operationId: reporting_schedules_detail_updateReportScheduleUpdate
description: Update a schedule object for reports.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportSchedule'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportScheduleUpdate'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
delete:
operationId: reporting_schedules_detail_destroyReportSchedule
description: Delete a concrete schedule given it's id.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/reporting/schedules/{id}/disable:
post:
operationId: reporting_schedules_disable_postDisableReportSchedule
description: 'Disable report schedule, with a given reason, to account users.
Schedule must be in status `enabled` to perform this call'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportScheduleDisable'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportSchedule'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/schedules/{id}/enable:
post:
operationId: reporting_schedules_enable_postEnableReportSchedule
description: 'Enable report schedule.
Schedule must be in status `disabled` and associated template not blocked
to perform this call'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportSchedule'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/schedules/{id}/trigger:
post:
operationId: reporting_schedules_trigger_postTriggerReportSchedule
description: Create new report based on this schedule's configuration.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/reporting/templates:
get:
operationId: reporting_templates_list_listReportTemplates
description: Get the report templates available in the collection.
tags:
- Reports
parameters:
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/reporting.RQLContentRangeLimitOffsetPagination.offset'
- name: audience.provider
description: 'Filter for: audience.provider
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: audience.vendor
description: 'Filter for: audience.vendor
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: local_id
description: 'Filter for: local_id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: repository.id
description: 'Filter for: repository.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: repository.name
description: 'Filter for: repository.name
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- enabled
- disabled
- blocked
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- system
- custom
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/reporting.ReportTemplate'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/templates/{id}:
get:
operationId: reporting_templates_detail_retrieveReportTemplate
description: Get a concrete report template given it's id.
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportTemplate'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/templates/{id}/disable:
post:
operationId: reporting_templates_disable_postDisableReportTemplate
description: 'Disable report templates, with a given reason, to account users.
Template must be in status `enabled` to perform this call'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportTemplateNotes'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportTemplate'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/reporting/templates/{id}/enable:
post:
operationId: reporting_templates_enable_postEnableReportTemplate
description: 'Enable report template.
Template must be in status `disabled` to perform this call'
tags:
- Reports
parameters:
- name: id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/reporting.ReportTemplate'
description: ''
'400':
$ref: '#/components/responses/reporting.any_400'
/conversations:
get:
operationId: conversations_conversations_list_listConversations
description: Get a list of all available Conversations in the collection.
tags:
- Conversations
parameters:
- $ref: '#/components/parameters/conversations.RQL1000Pagination.limit'
- $ref: '#/components/parameters/conversations.RQL1000Pagination.offset'
- name: created
description: 'Filter for: created
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: instance_id
description: 'Filter for: instance_id
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/conversations.Conversation'
examples:
default:
$ref: '#/components/examples/conversations.Conversation-list'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/conversations.any_400'
post:
operationId: conversations_conversations_list_createConversation
description: 'Allows the creation of a Conversation attached to a given object
of Connect.
**WARNING! The creation of conversations is only available to CloudBlue Connect
platform
modules and is done automatically for most of the business objects handled
by CloudBlue
Connect. External actors can list conversations and add messages to existing
ones but will
not be able to create new conversations.**'
tags:
- Conversations
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Conversation'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Conversation'
examples:
default:
$ref: '#/components/examples/conversations.Conversation'
description: ''
'400':
$ref: '#/components/responses/conversations.any_400'
/conversations/{conversation_id}/messages:
get:
operationId: conversations_conversation_messages_list_listMessages
description: Get a list of all available Messages for a given conversation.
tags:
- Conversations
parameters:
- name: conversation_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/conversations.RQL1000Pagination.limit'
- $ref: '#/components/parameters/conversations.RQL1000Pagination.offset'
- name: created
description: 'Filter for: created
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: text
description: 'Filter for: text
**lookups:** eq, ne, like, ilike, in, out
**search:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- message
- state_change
- private
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/conversations.Message'
examples:
default:
$ref: '#/components/examples/conversations.Message-list'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/conversations.any_400'
post:
operationId: conversations_conversation_messages_list_createMessage
description: Create a new Message for a given conversation.
tags:
- Conversations
parameters:
- name: conversation_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Message'
examples:
new_conv_message:
$ref: '#/components/examples/conversations.CreateMessage-new_conv_message'
new_conv_private_message:
$ref: '#/components/examples/conversations.CreateMessage-new_conv_private_message'
new_conv_state_change_message:
$ref: '#/components/examples/conversations.CreateMessage-new_conv_state_change_message'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Message'
examples:
default:
$ref: '#/components/examples/conversations.Message'
description: ''
'400':
$ref: '#/components/responses/conversations.any_400'
/conversations/{conversation_id}/messages/{id}:
put:
operationId: conversations_conversation_messages_detail_updateMessage
description: Update specific Message given by id of a given conversation.
tags:
- Conversations
parameters:
- name: conversation_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique value identifying this message.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Message'
examples:
update_conv_message:
$ref: '#/components/examples/conversations.UpdateMessage-update_conv_message'
update_conv_private_message:
$ref: '#/components/examples/conversations.UpdateMessage-update_conv_private_message'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Message'
examples:
default:
$ref: '#/components/examples/conversations.Message'
description: ''
'400':
$ref: '#/components/responses/conversations.any_400'
/conversations/{id}:
get:
operationId: conversations_conversations_detail_retrieveConversation
description: Get a specific Conversation by id or instance_id
tags:
- Conversations
parameters:
- name: id
in: path
required: true
description: A unique value identifying this conversation.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Conversation'
examples:
default:
$ref: '#/components/examples/conversations.Conversation'
description: ''
'400':
$ref: '#/components/responses/conversations.any_400'
delete:
operationId: conversations_conversations_detail_destroyConversation
description: Delete a Conversation given its id.
tags:
- Conversations
parameters:
- name: id
in: path
required: true
description: A unique value identifying this conversation.
schema:
type: string
responses:
'204':
description: ''
/conversations/{id}/close:
post:
operationId: conversations_conversations_close_postCloseConversation
description: Close conversation. New messages can't be added to a "closed" conversation.
tags:
- Conversations
parameters:
- name: id
in: path
required: true
description: A unique value identifying this conversation.
schema:
type: string
requestBody:
content:
application/json: {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/conversations.Conversation'
examples:
default:
$ref: '#/components/examples/conversations.Conversation'
description: ''
'400':
$ref: '#/components/responses/conversations.any_400'
/offers:
get:
operationId: offers_offers_list_listOfferVersions
description: '# Create and manage Offers.
First Offer version is created with Offer creation.'
tags:
- Offers
parameters:
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.listings
description: 'Filter for: stats.listings
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.versions
description: 'Filter for: stats.versions
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- private
- ready
- listed
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- generic
- commerce
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.Offer'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_offers_list_createOfferVersion
description: '# Create and manage Offers.
First Offer version is created with Offer creation.'
tags:
- Offers
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Offer'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Offer'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers-ns/forms:
get:
operationId: offers_attributes_form_list_listAttributeForms
description: '# List Attributes Forms use for plan settings, presets, etc.'
tags:
- AttributesForm
parameters:
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: scope
description: 'Filter for: scope
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- commerce
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- preset_plan
- preset_switch
- blueprint_plan
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.AttributeForm'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
/offers-ns/forms/{id}:
get:
operationId: offers_attributes_form_detail_retrieveAttributeForm
description: '# List Attributes Forms use for plan settings, presets, etc.'
tags:
- AttributesForm
parameters:
- name: id
in: path
required: true
description: A unique value identifying this Attribute Form.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.AttributeForm'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers-ns/presets:
get:
operationId: offers_presets_list_listPresetVersions
description: ''
tags:
- PresetVersions
parameters:
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- draft
- published
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- plan
- switch
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.PresetCreate'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_presets_list_createPresetVersion
description: ''
tags:
- PresetVersions
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetCreate'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers-ns/presets/{id}:
get:
operationId: offers_presets_detail_retrievePresetVersion
description: ''
tags:
- PresetVersions
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this preset version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetCreate'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_presets_detail_updatePresetVersion
description: ''
tags:
- PresetVersions
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this preset version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetUpdate'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_presets_detail_destroyPresetVersion
description: ''
tags:
- PresetVersions
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this preset version.
schema:
type: string
responses:
'204':
description: ''
/offers-ns/presets/{id}/attributes:
get:
operationId: offers_presets_attributes_getAttributesPresetVersion
description: ''
tags:
- PresetVersions
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this preset version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetCreate'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_presets_attributes_putAttributesPresetVersion
description: ''
tags:
- PresetVersions
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this preset version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetCreate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetCreate'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers-ns/presets/{preset_pk}/versions:
get:
operationId: offers_presets_versions_list_listPresetVersions
description: ''
tags:
- PresetVersions
parameters:
- name: preset_pk
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.PresetVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_presets_versions_list_createPresetVersion
description: ''
tags:
- PresetVersions
parameters:
- name: preset_pk
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetVersion'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetVersion'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers-ns/presets/{preset_pk}/versions/{id}:
get:
operationId: offers_presets_versions_detail_retrievePresetVersion
description: ''
tags:
- PresetVersions
parameters:
- name: preset_pk
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this preset version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.PresetVersion'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/-/versions:
get:
operationId: offers_offers_versions_all_list_listOfferVersions
description: '# List all Offer versions.'
tags:
- Offers
parameters:
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.listings
description: 'Filter for: stats.listings
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.versions
description: 'Filter for: stats.versions
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- private
- ready
- listed
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- generic
- commerce
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.OfferVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{id}:
get:
operationId: offers_offers_detail_retrieveOfferVersion
description: '# Create and manage Offers.
First Offer version is created with Offer creation.'
tags:
- Offers
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this offer version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Offer'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_detail_updateOfferVersion
description: '# Create and manage Offers.
First Offer version is created with Offer creation.'
tags:
- Offers
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this offer version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Offer'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Offer'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_offers_detail_destroyOfferVersion
description: '# Create and manage Offers.
First Offer version is created with Offer creation.'
tags:
- Offers
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this offer version.
schema:
type: string
responses:
'204':
description: ''
/offers/{id}/clone:
post:
operationId: offers_offers_clone_postCloneOfferVersion
description: '# Create and manage Offers.
First Offer version is created with Offer creation.'
tags:
- Offers
parameters:
- name: id
in: path
required: true
description: A unique integer value identifying this offer version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Offer'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Offer'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/blueprints/commerce/plans:
get:
operationId: offers_offers_blueprint_plans_list_listPlanVersions
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: countries
description: 'Filter for: countries
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: end_of_access
description: 'Filter for: end_of_access
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: plan.id
description: 'Filter for: plan.id
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.Plan'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/blueprints/commerce/plans/{id}:
get:
operationId: offers_offers_blueprint_plans_detail_retrievePlanVersion
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_blueprint_plans_detail_updatePlanVersion
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_offers_blueprint_plans_detail_destroyPlanVersion
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
responses:
'204':
description: ''
/offers/{offer_id}/blueprints/commerce/plans/{id}/attributes:
get:
operationId: offers_offers_blueprint_plans_attributes_getAttributesPlanVersion
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_blueprint_plans_attributes_putAttributesPlanVersion
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/features:
get:
operationId: offers_offers_features_list_listFeatureVersions
description: '# Create and manage Features.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: group.id
description: 'Filter for: group.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.name
description: 'Filter for: group.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.position
description: 'Filter for: group.position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.Feature'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_offers_features_list_createFeatureVersion
description: '# Create and manage Features.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Feature'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Feature'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/features-groups:
get:
operationId: offers_offers_featuresgroups_list_listFeaturesGroupVersions
description: '# Create and manage Feature groups.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.FeaturesGroup'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_offers_featuresgroups_list_createFeaturesGroupVersion
description: '# Create and manage Feature groups.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.FeaturesGroup'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.FeaturesGroup'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/features-groups/{id}:
get:
operationId: offers_offers_featuresgroups_detail_retrieveFeaturesGroupVersion
description: '# Create and manage Feature groups.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this features group version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.FeaturesGroup'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_featuresgroups_detail_updateFeaturesGroupVersion
description: '# Create and manage Feature groups.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this features group version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.FeaturesGroup'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.FeaturesGroup'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_offers_featuresgroups_detail_destroyFeaturesGroupVersion
description: '# Create and manage Feature groups.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this features group version.
schema:
type: string
responses:
'204':
description: ''
/offers/{offer_id}/features/{id}:
get:
operationId: offers_offers_features_detail_retrieveFeatureVersion
description: '# Create and manage Features.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this feature version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Feature'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_features_detail_updateFeatureVersion
description: '# Create and manage Features.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this feature version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Feature'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Feature'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_offers_features_detail_destroyFeatureVersion
description: '# Create and manage Features.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this feature version.
schema:
type: string
responses:
'204':
description: ''
/offers/{offer_id}/items:
get:
operationId: offers_offers_items_list_listOfferItemVersions
description: '# Create and manage Offer items.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.by.id
description: 'Filter for: events.updated.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.by.name
description: 'Filter for: events.updated.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.OfferItem'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_offers_items_list_createOfferItemVersion
description: '# Create and manage Offer items.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferItem'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferItem'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/items/{id}:
get:
operationId: offers_offers_items_detail_retrieveOfferItemVersion
description: '# Create and manage Offer items.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this offer item version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferItem'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_items_detail_updateOfferItemVersion
description: '# Create and manage Offer items.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this offer item version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferItem'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferItem'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_offers_items_detail_destroyOfferItemVersion
description: '# Create and manage Offer items.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this offer item version.
schema:
type: string
responses:
'204':
description: ''
/offers/{offer_id}/plans:
get:
operationId: offers_offers_plans_list_listPlanVersions
description: '# Create and manage Plans.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: color
description: 'Filter for: color
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: description
description: 'Filter for: description
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: periods
description: 'Filter for: periods
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.Plan'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_offers_plans_list_createPlanVersion
description: '# Create and manage Plans.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/plans/{id}:
get:
operationId: offers_offers_plans_detail_retrievePlanVersion
description: '# Create and manage Plans.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_plans_detail_updatePlanVersion
description: '# Create and manage Plans.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_offers_plans_detail_destroyPlanVersion
description: '# Create and manage Plans.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
responses:
'204':
description: ''
/offers/{offer_id}/switches:
get:
operationId: offers_offers_switches_list_listSwitches
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: from.id
description: 'Filter for: from.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: from.name
description: 'Filter for: from.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: preset.id
description: 'Filter for: preset.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: preset.name
description: 'Filter for: preset.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: to.id
description: 'Filter for: to.id
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: to.name
description: 'Filter for: to.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- upgrade
- downgrade
- eos
- change
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.Switch'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_offers_switches_list_createSwitchCreate
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.SwitchCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.SwitchCreate'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/switches/{switch_id}:
get:
operationId: offers_offers_switches_detail_retrieveSwitch
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: switch_id
in: path
required: true
description: ''
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Switch'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_switches_detail_updateSwitchUpdate
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: switch_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.SwitchUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.SwitchUpdate'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
delete:
operationId: offers_offers_switches_detail_destroySwitch
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: switch_id
in: path
required: true
description: ''
schema:
type: string
responses:
'204':
description: ''
/offers/{offer_id}/versions:
get:
operationId: offers_offers_versions_list_listOfferVersions
description: '# Create and manage Offer versions.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.id
description: 'Filter for: product.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: product.name
description: 'Filter for: product.name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: stats.listings
description: 'Filter for: stats.listings
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: stats.versions
description: 'Filter for: stats.versions
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: status
description: 'Filter for: status
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- private
- ready
- listed
- name: type
description: 'Filter for: type
**lookups:** eq, ne, like, ilike, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
enum:
- generic
- commerce
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.OfferVersion'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
post:
operationId: offers_offers_versions_list_createOfferVersion
description: '# Create and manage Offer versions.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferVersion'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferVersion'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{id}:
get:
operationId: offers_offers_versions_detail_retrieveOfferVersion
description: '# Create and manage Offer versions.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this offer version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferVersion'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
put:
operationId: offers_offers_versions_detail_updateOfferVersion
description: '# Create and manage Offer versions.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this offer version.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferVersion'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.OfferVersion'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/blueprints/commerce/plans:
get:
operationId: offers_offerversion_blueprint_plans_list_listPlanVersions
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: countries
description: 'Filter for: countries
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
- name: end_of_access
description: 'Filter for: end_of_access
**lookups:** eq, ne'
in: query
required: false
deprecated: false
schema:
type: boolean
- name: plan.id
description: 'Filter for: plan.id
**lookups:** eq, in'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.Plan'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/blueprints/commerce/plans/{id}:
get:
operationId: offers_offerversion_blueprint_plans_detail_retrievePlanVersion
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/blueprints/commerce/plans/{id}/attributes:
get:
operationId: offers_offerversion_blueprint_plans_attributes_getAttributesPlanVersion
description: ''
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this plan version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Plan'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/features:
get:
operationId: offers_offerversion_features_list_listFeatureVersions
description: '# List Features for specified Offer version.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: group.id
description: 'Filter for: group.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.name
description: 'Filter for: group.name
**lookups:** eq, ne, like, ilike, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: group.position
description: 'Filter for: group.position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.Feature'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/features-groups:
get:
operationId: offers_offerversion_featuresgroups_list_listFeaturesGroupVersions
description: '# List Feature groups for specified Offer version.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
- name: position
description: 'Filter for: position
**lookups:** eq, ne, ge, gt, le, lt, null, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.FeaturesGroup'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/features-groups/{id}:
get:
operationId: offers_offerversion_featuresgroups_detail_retrieveFeaturesGroupVersion
description: '# List Feature groups for specified Offer version.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this features group version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.FeaturesGroup'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/features/{id}:
get:
operationId: offers_offerversion_features_detail_retrieveFeatureVersion
description: '# List Features for specified Offer version.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- name: id
in: path
required: true
description: A unique integer value identifying this feature version.
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/offers.Feature'
description: ''
'400':
$ref: '#/components/responses/offers.any_400'
/offers/{offer_id}/versions/{offerversion_id}/items:
get:
operationId: offers_offerversion_items_list_listOfferItemVersions
description: '# List Offer items for specified Offer version.'
tags:
- Offers
parameters:
- name: offer_id
in: path
required: true
description: ''
schema:
type: string
- name: offerversion_id
in: path
required: true
description: ''
schema:
type: string
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.limit'
- $ref: '#/components/parameters/offers.RQLContentRangeLimitOffsetPagination.offset'
- name: events.created.at
description: 'Filter for: events.created.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.created.by.id
description: 'Filter for: events.created.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.created.by.name
description: 'Filter for: events.created.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.at
description: 'Filter for: events.updated.at
**lookups:** eq, ne, ge, gt, le, lt, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
format: date-time
- name: events.updated.by.id
description: 'Filter for: events.updated.by.id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: events.updated.by.name
description: 'Filter for: events.updated.by.name
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: id
description: 'Filter for: id
**lookups:** eq, ne, like, ilike, null, in, out'
in: query
required: false
deprecated: false
schema:
type: string
- name: name
description: 'Filter for: name
**lookups:** eq, ne, like, ilike, in, out
**ordering:** true'
in: query
required: false
deprecated: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/offers.OfferItem'
description: ''
headers:
Content-Range:
$ref: '#/components/headers/Content-Range'
'400':
$