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 Fri May 30\ \ 10:59:38 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: '37.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: ![logo](https://domain.com/image.jpg) ' 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: alt_pricelist_1.id description: 'Filter for: alt_pricelist_1.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: alt_pricelist_1.name description: 'Filter for: alt_pricelist_1.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: alt_pricelist_2.id description: 'Filter for: alt_pricelist_2.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: alt_pricelist_2.name description: 'Filter for: alt_pricelist_2.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' 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: alt_currency_1 description: 'Filter for: alt_currency_1 **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: alt_currency_2 description: 'Filter for: alt_currency_2 **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: 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: '' /metrics: get: operationId: dp_metrics_list_listMetricsViewSets description: '' tags: - Metrics parameters: [] responses: '200': content: application/json: schema: type: array items: {} description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' /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}/guidelines: get: operationId: dp_product_guidelines_list_listGuidelines description: '' tags: - Guidelines 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: action description: 'Filter for: action **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - conflicts - requires - provided_by - name: from.id description: 'Filter for: from.id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: from.type description: 'Filter for: from.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - item - name: id description: 'Filter for: id **lookups:** eq, ne, ge, gt, le, lt, null, in, out' in: query required: false deprecated: false schema: type: integer - name: scope description: 'Filter for: scope **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string enum: - account - subscription - name: to.id description: 'Filter for: to.id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: to.type description: 'Filter for: to.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - item responses: '200': content: application/json: schema: type: array items: {} description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' post: operationId: dp_product_guidelines_list_createGuidelineCreate description: '' tags: - Guidelines 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}/guidelines/{guideline_id}: get: operationId: dp_product_guidelines_detail_retrieveGuideline description: '' tags: - Guidelines parameters: - name: product_product_id in: path required: true description: '' schema: type: string - name: guideline_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: {} description: '' put: operationId: dp_product_guidelines_detail_updateGuidelineUpdate description: '' tags: - Guidelines parameters: - name: product_product_id in: path required: true description: '' schema: type: string - name: guideline_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_guidelines_detail_destroyGuideline description: '' tags: - Guidelines parameters: - name: product_product_id in: path required: true description: '' schema: type: string - name: guideline_id in: path required: true description: '' schema: type: string responses: '204': description: '' /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: applicability description: 'Filter for: applicability **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string enum: - cb - im - 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 - days_7_trial - days_14_trial - days_30_trial - monthly_trial - 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}/guidelines: get: operationId: dp_product_version_guidelines_list_listGuidelines description: '' tags: - Guidelines 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: action description: 'Filter for: action **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - conflicts - requires - provided_by - name: from.id description: 'Filter for: from.id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: from.type description: 'Filter for: from.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - item - name: id description: 'Filter for: id **lookups:** eq, ne, ge, gt, le, lt, null, in, out' in: query required: false deprecated: false schema: type: integer - name: scope description: 'Filter for: scope **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string enum: - account - subscription - name: to.id description: 'Filter for: to.id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: to.type description: 'Filter for: to.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - item 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}/guidelines/{guideline_id}: get: operationId: dp_product_version_guidelines_detail_retrieveGuideline description: '' tags: - Guidelines 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: guideline_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: {} description: '' /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: applicability description: 'Filter for: applicability **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string enum: - cb - im - 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 - days_7_trial - days_14_trial - days_30_trial - monthly_trial - 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 - transfer - 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: ![logo](https://domain.com/image.jpg) ' 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: ![logo](https://domain.com/image.jpg) ' 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: ![logo](https://domain.com/image.jpg) ' 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 - inquiring_validator - change_validator - change_inquiring_validator - renew_validator - renew_inquiring_validator - transfer_validator - transfer_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_t1_inq_val - change_inquiring_validator - renew_validator - draft_tcr_t2_val - draft_tcr_t1_val - event - tcr_setup_t1_inq_val - validator - change_validator - tcr_setup_t2_inq_val - tcr_update_t1_validator - transfer_inquiring_validator - renew_inquiring_validator - transfer_validator - tcr_update_t2_validator - tcr_update_t2_inq_val object_class: type: string enum: - fulfillment_request - listing_request - usage_file - tier_account_request - billing_request - tier_config_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_t1_inq_val - change_inquiring_validator - renew_validator - draft_tcr_t2_val - draft_tcr_t1_val - event - tcr_setup_t1_inq_val - validator - change_validator - tcr_setup_t2_inq_val - tcr_update_t1_validator - transfer_inquiring_validator - renew_inquiring_validator - transfer_validator - tcr_update_t2_validator - tcr_update_t2_inq_val object_class: type: string enum: - fulfillment_request - listing_request - usage_file - tier_account_request - billing_request - tier_config_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: 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 **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.listings_alt description: 'Filter for: stats.listings_alt **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. Fields ''stats.listings'' and ''stats.listings_alt'' are 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.listings_alt description: 'Filter for: pricelist.stats.listings_alt **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: expiration_date description: 'Filter for: expiration_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: 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 - expiring - expired - revitalised 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/{pk}/renew: post: operationId: auth_tokens_renew_postRenewToken description: 'Renew the token by generating a new secret key and setting a new expiration date. The previous secret key is still valid until its expiration date.' tags: - Extensions parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.TokenRenewRotate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/auth.Token' description: '' '400': $ref: '#/components/responses/auth.any_400' /auth/tokens/{pk}/rotate: post: operationId: auth_tokens_rotate_postRotateToken description: Rotate the token by generating a new secret key and updating the expiration date. tags: - Extensions parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/auth.TokenRenewRotate' 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 ips: type: array items: type: object properties: name: type: string ip_range: type: array items: type: string format: ipv4 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/MD-0007/settings: get: operationId: auth_modules_integrations_id_settings_list_listAccountIntegrationsSettingsModuleViewSets description: '' tags: - General Collections parameters: [] responses: '200': content: application/json: schema: type: object properties: acl: type: object properties: ips: type: array items: type: object properties: name: type: string ip_range: type: array items: type: string format: ipv4 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 ips: type: array items: type: object properties: name: type: string ip_range: type: array items: type: string format: ipv4 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/integrations/settings: get: operationId: auth_modules_integrations_alias_settings_list_listAccountIntegrationsSettingsModuleViewSets description: '' tags: - General Collections parameters: [] responses: '200': content: application/json: schema: type: object properties: acl: type: object properties: ips: type: array items: type: object properties: name: type: string ip_range: type: array items: type: string format: ipv4 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: - Offers Attributes Forms 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: - Offers Attributes Forms 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: - Offers Presets 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: - Offers Presets 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: - Offers Presets 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-ns/presets/{preset_pk}/versions/{id}/attributes: get: operationId: offers_presets_versions_attributes_getAttributesPresetVersion description: '' tags: - Offers Presets 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: get: operationId: offers_offers_blueprint_bulk_attributes_list_listCommerceAttributeBulkUpdates description: '' tags: - Offers Blueprints parameters: - name: offer_id 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: {} description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/offers.any_400' post: operationId: offers_offers_blueprint_bulk_attributes_list_createCommerceAttributeBulkUpdate description: '' tags: - Offers Blueprints parameters: - name: offer_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/offers.any_400' /offers/{offer_id}/blueprints/commerce/attributes: put: operationId: offers_offers_blueprint_bulk_attributes_attributes_putAttributesCommerceAttributeBulkUpdate description: '' tags: - Offers Blueprints parameters: - name: offer_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/offers.any_400' /offers/{offer_id}/blueprints/commerce/plans: get: operationId: offers_offers_blueprint_plans_list_listBlueprintPlans description: '' tags: - Offers Blueprints 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 - name: status description: 'Filter for: status **lookups:** eq, ne, in' in: query required: false deprecated: false schema: type: string enum: - draft - active - endofsale responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/offers.BlueprintPlan' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/blueprints/commerce/plans/-/attributes: get: operationId: offers_offers_blueprint_plans_collection_attributes_getCollection_attributesBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.CommerceBlueprintPlanCollectionAttributes' description: '' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/blueprints/commerce/plans/{id}: get: operationId: offers_offers_blueprint_plans_detail_retrieveBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this Blueprint Plan. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' description: '' '400': $ref: '#/components/responses/offers.any_400' put: operationId: offers_offers_blueprint_plans_detail_updateBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this Blueprint Plan. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' description: '' '400': $ref: '#/components/responses/offers.any_400' delete: operationId: offers_offers_blueprint_plans_detail_destroyBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this Blueprint Plan. schema: type: string responses: '204': description: '' /offers/{offer_id}/blueprints/commerce/plans/{id}/attributes: get: operationId: offers_offers_blueprint_plans_attributes_getAttributesBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this Blueprint Plan. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' description: '' '400': $ref: '#/components/responses/offers.any_400' put: operationId: offers_offers_blueprint_plans_attributes_putAttributesBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this Blueprint Plan. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' description: '' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/blueprints/commerce/plans/{id}/endsale: post: operationId: offers_offers_blueprint_plans_endsale_postEndsaleBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this Blueprint Plan. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' description: '' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/blueprints/commerce/plans/{id}/resumesale: post: operationId: offers_offers_blueprint_plans_resumesale_postResumesaleBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this Blueprint Plan. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' description: '' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/blueprints/commerce/{id}: get: operationId: offers_offers_blueprint_bulk_attributes_detail_retrieveCommerceAttributeBulkUpdate description: '' tags: - Offers Blueprints parameters: - name: offer_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: '' '400': $ref: '#/components/responses/offers.any_400' put: operationId: offers_offers_blueprint_bulk_attributes_detail_updateCommerceAttributeBulkUpdate description: '' tags: - Offers Blueprints parameters: - name: offer_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/offers.any_400' patch: operationId: offers_offers_blueprint_bulk_attributes_detail_partial_updateCommerceAttributeBulkUpdate description: '' tags: - Offers Blueprints parameters: - name: offer_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/offers.any_400' delete: operationId: offers_offers_blueprint_bulk_attributes_detail_destroyCommerceAttributeBulkUpdate description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /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: commitments description: 'Filter for: commitments **lookups:** eq, in' 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/-/inventory: get: operationId: offers_offerplans_inventory_list_listOfferItemValues 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: commitments description: 'Filter for: commitments **lookups:** eq, in' in: query required: false deprecated: false schema: type: string - name: offer_item.id description: 'Filter for: offer_item.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: period description: 'Filter for: period **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - days_7_trial - days_14_trial - monthly - monthly_trial - yearly - years_2 - years_3 - years_4 - years_5 - years_6 - onetime - trial - name: plan.id description: 'Filter for: plan.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/offers.OfferItemValue' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/plans/-/inventory/{id}: delete: operationId: offers_offerplans_inventory_detail_destroyOfferItemValue 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 offer item value. schema: type: string responses: '204': description: '' /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}/switches/{switch_id}/endsale: post: operationId: offers_offers_switches_endsale_postEndsaleSwitch 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.Switch' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.Switch' description: '' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/switches/{switch_id}/resumesale: post: operationId: offers_offers_switches_resumesale_postResumesaleSwitch 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.Switch' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.Switch' description: '' '400': $ref: '#/components/responses/offers.any_400' /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_listBlueprintPlans description: '' tags: - Offers Blueprints 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 - name: status description: 'Filter for: status **lookups:** eq, ne, in' in: query required: false deprecated: false schema: type: string enum: - draft - active - endofsale responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/offers.BlueprintPlan' 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/-/attributes: get: operationId: offers_offerversion_blueprint_plans_collection_attributes_getCollection_attributesBlueprintPlan description: '' tags: - Offers Blueprints parameters: - name: offer_id in: path required: true description: '' schema: type: string - name: offerversion_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.CommerceBlueprintPlanCollectionAttributes' description: '' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/versions/{offerversion_id}/blueprints/commerce/plans/{id}: get: operationId: offers_offerversion_blueprint_plans_detail_retrieveBlueprintPlan description: '' tags: - Offers Blueprints 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 value identifying this Blueprint Plan. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' 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_getAttributesBlueprintPlan description: '' tags: - Offers Blueprints 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 value identifying this Blueprint Plan. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.BlueprintPlan' 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': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/versions/{offerversion_id}/items/{id}: get: operationId: offers_offerversion_items_detail_retrieveOfferItemVersion 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 - 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' /offers/{offer_id}/versions/{offerversion_id}/plans: get: operationId: offers_offerversion_plans_list_listPlanVersions description: List Plans 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: color description: 'Filter for: color **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: commitments description: 'Filter for: commitments **lookups:** eq, in' 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' /offers/{offer_id}/versions/{offerversion_id}/plans/-/inventory: get: operationId: offers_offerversionplans_inventory_list_listOfferItemValues description: List Plans 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: commitments description: 'Filter for: commitments **lookups:** eq, in' in: query required: false deprecated: false schema: type: string - name: offer_item.id description: 'Filter for: offer_item.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: period description: 'Filter for: period **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - days_7_trial - days_14_trial - monthly - monthly_trial - yearly - years_2 - years_3 - years_4 - years_5 - years_6 - onetime - trial - name: plan.id description: 'Filter for: plan.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/offers.OfferItemValue' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/versions/{offerversion_id}/plans/{id}: get: operationId: offers_offerversion_plans_detail_retrievePlanVersion description: List Plans 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 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}/switches: get: operationId: offers_offerversion_switches_list_listSwitches 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: 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_offerversion_switches_list_createSwitchCreate 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 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}/versions/{offerversion_id}/switches/{switch_id}: get: operationId: offers_offerversion_switches_detail_retrieveSwitch 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: 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_offerversion_switches_detail_updateSwitchUpdate 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: 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_offerversion_switches_detail_destroySwitch 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: switch_id in: path required: true description: '' schema: type: string responses: '204': description: '' /offers/{offer_id}/versions/{offerversion_id}/switches/{switch_id}/endsale: post: operationId: offers_offerversion_switches_endsale_postEndsaleSwitch 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: switch_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/offers.Switch' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.Switch' description: '' '400': $ref: '#/components/responses/offers.any_400' /offers/{offer_id}/versions/{offerversion_id}/switches/{switch_id}/resumesale: post: operationId: offers_offerversion_switches_resumesale_postResumesaleSwitch 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: switch_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/offers.Switch' responses: '200': content: application/json: schema: $ref: '#/components/schemas/offers.Switch' description: '' '400': $ref: '#/components/responses/offers.any_400' /accounts/{account}/statistics: get: operationId: statistics_account_statistics_retrieveStat description: Retrieve Account Statistics. tags: - Statistics parameters: - name: account in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/statistics.Statistics' description: '' '400': $ref: '#/components/responses/statistics.any_400' post: operationId: statistics_account_statistics_postCalculateStat description: Calculate/recalculate Statistics for an Account. tags: - Statistics parameters: - name: account in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/statistics.Statistics' responses: '200': content: application/json: schema: $ref: '#/components/schemas/statistics.Statistics' description: '' '400': $ref: '#/components/responses/statistics.any_400' /statistics/tokens/{id}/aggregates: get: operationId: statistics_account_token_aggregates_getAggregatesAccountTokenAggregates description: Retrieve daily aggregates of the Account Token statuses. tags: - Statistics parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/statistics.AccountTokenAggregates' description: '' '400': $ref: '#/components/responses/statistics.any_400' /statistics/tokens/{id}/summary: get: operationId: statistics_account_token_summary_getSummaryAccountTokenSummary description: Retrieve a summary of the Account Token statistics. tags: - Statistics parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/statistics.AccountTokenSummary' description: '' '400': $ref: '#/components/responses/statistics.any_400' /helpdesk/cases: get: operationId: helpdesk_cases_list_listCases description: 'Lists Helpdesk Case objects available in the collection. If the case has been created not about a particular product -- the "product" section of the response will not be returned.' tags: - Helpdesk parameters: - $ref: '#/components/parameters/helpdesk.RQL1000Pagination.limit' - $ref: '#/components/parameters/helpdesk.RQL1000Pagination.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.closed.at description: 'Filter for: events.closed.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.closed.by.id description: 'Filter for: events.closed.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.closed.by.name description: 'Filter for: events.closed.by.name **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, in, out **ordering:** true **default:** *hidden*' 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, in, out **ordering:** true **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: events.inquiring.at description: 'Filter for: events.inquiring.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.inquiring.by.id description: 'Filter for: events.inquiring.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.inquiring.by.name description: 'Filter for: events.inquiring.by.name **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: events.pending.at description: 'Filter for: events.pending.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.pending.by.id description: 'Filter for: events.pending.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.pending.by.name description: 'Filter for: events.pending.by.name **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: events.resolved.at description: 'Filter for: events.resolved.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.resolved.by.id description: 'Filter for: events.resolved.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.resolved.by.name description: 'Filter for: events.resolved.by.name **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true **default:** *hidden*' 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, in, out **ordering:** true **default:** *hidden*' 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, 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: issuer.account.id description: 'Filter for: issuer.account.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: issuer.account.name description: 'Filter for: issuer.account.name **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: issuer.agent.id description: 'Filter for: issuer.agent.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: issuer.agent.name description: 'Filter for: issuer.agent.name **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - 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 enum: - 0 - 1 - 2 - 3 - name: receiver.account.id description: 'Filter for: receiver.account.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: receiver.account.name description: 'Filter for: receiver.account.name **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: receiver.agent.id description: 'Filter for: receiver.agent.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: receiver.agent.name description: 'Filter for: receiver.agent.name **lookups:** eq, ne, like, ilike, null, 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: - pending - inquiring - resolved - closed - name: subject description: 'Filter for: subject **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 **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - technical - business responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/helpdesk.any_400' post: operationId: helpdesk_cases_list_createCase description: "Creates a new Helpdesk Case for a given Partner. Your case may\ \ (or may not) be related\nto a particular Product. When creating the Case\ \ you should specify the priority from `0` to `3`:\n * `0` -- Low\n * `1`\ \ -- Medium\n * `2` -- High\n * `3` -- Urgent" tags: - Helpdesk parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: vendor_to_dist_no_prod: $ref: '#/components/examples/helpdesk.CreateCase-vendor_to_dist_no_prod' vendor_to_dist_no_prod_hub: $ref: '#/components/examples/helpdesk.CreateCase-vendor_to_dist_no_prod_hub' vendor_to_dist_w_prod: $ref: '#/components/examples/helpdesk.CreateCase-vendor_to_dist_w_prod' dist_to_vendor_w_prod: $ref: '#/components/examples/helpdesk.CreateCase-dist_to_vendor_w_prod' responses: '201': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /helpdesk/cases/{cases_id}/attachments: get: operationId: helpdesk_cases_attachments_list_listAttachments description: Get all attachments for a particular Helpdesk Case. tags: - Helpdesk parameters: - name: cases_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/helpdesk.RQL1000Pagination.limit' - $ref: '#/components/parameters/helpdesk.RQL1000Pagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/helpdesk.Attachment' examples: default: $ref: '#/components/examples/helpdesk.Attachment-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/helpdesk.any_400' post: operationId: helpdesk_cases_attachments_list_createAttachment description: Adds a new attachment to a particular Helpdesk Case. tags: - Helpdesk parameters: - name: cases_id in: path required: true description: '' schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary description: 'You can upload files of any type of content. Please be sure to specify the `Content-Type` header as `multipart/form-data`, the `Content-Length` headers with the correct data size. The body of the request must be a `form-data` body with the key `file` and value -- **base64 encoded** string of the binary content. **CURL** example: `curl --location --request POST "https://../public/v1/helpdesk/cases/CA-594-965-699/attachments" --header "Authorization: ApiKey ...:..." --form ''file=@"/path/to/file/file.png"''`' responses: '201': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Attachment' examples: default: $ref: '#/components/examples/helpdesk.Attachment' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /helpdesk/cases/{cases_id}/attachments/{id}: get: operationId: helpdesk_cases_attachments_detail_retrieveAttachment description: Get attachment details for a particular Helpdesk Case given the attachment id. tags: - Helpdesk parameters: - name: cases_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this attachment. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Attachment' examples: default: $ref: '#/components/examples/helpdesk.Attachment' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' delete: operationId: helpdesk_cases_attachments_detail_destroyAttachment description: Remove attachment for a particular Helpdesk Case given the attachment id. tags: - Helpdesk parameters: - name: cases_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: A unique value identifying this attachment. schema: type: string responses: '204': description: '' /helpdesk/cases/{id}: get: operationId: helpdesk_cases_detail_retrieveCase description: Get a particular Helpdesk Case object given its id. tags: - Helpdesk parameters: - name: id in: path required: true description: A unique value identifying this case. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' put: operationId: helpdesk_cases_detail_updateCase description: 'Update specific properties of the Helpdesk Case. You can update almost everything on your case. Please refer to schema for more details on the fields available.' tags: - Helpdesk parameters: - name: id in: path required: true description: A unique value identifying this case. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: change_case_product: $ref: '#/components/examples/helpdesk.UpdateCase-change_case_product' update_subj_and_desc: $ref: '#/components/examples/helpdesk.UpdateCase-update_subj_and_desc' update_priority: $ref: '#/components/examples/helpdesk.UpdateCase-update_priority' update_type: $ref: '#/components/examples/helpdesk.UpdateCase-update_type' responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /helpdesk/cases/{id}/close: post: operationId: helpdesk_cases_close_postCloseCase description: 'Close a particular Helpdesk Case object given its id. You may optionally provide `rating` value from `1` to `5` being `1` very poor satisfaction rate and `5` very high satisfaction rate and `feedback` value. The case must be in `resolved` state to be able to close it.' tags: - Helpdesk parameters: - name: id in: path required: true description: A unique value identifying this case. schema: type: string requestBody: content: application/json: schema: properties: rating: type: string enum: - 1 - 2 - 3 - 4 - 5 feedback: type: string type: object description: Description of the *Case* model. responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /helpdesk/cases/{id}/inquire: post: operationId: helpdesk_cases_inquire_postInquireCase description: 'Inquire for additional information to the other side of the case, i.e. from Vendor to Distributor or vice versa. The case must be in `pending` state to perform inquire operation. This operation requires no request body.' tags: - Helpdesk parameters: - name: id in: path required: true description: A unique value identifying this case. schema: type: string requestBody: content: application/json: {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /helpdesk/cases/{id}/pend: post: operationId: helpdesk_cases_pend_postPendCase description: 'Move Helpdesk Case to the pending state. The case must be either in `inquiring` or `resolved` states to perform pend operation. This operation requires no request body.' tags: - Helpdesk parameters: - name: id in: path required: true description: A unique value identifying this case. schema: type: string requestBody: content: application/json: {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /helpdesk/cases/{id}/resolve: post: operationId: helpdesk_cases_resolve_postResolveCase description: 'Mark Helpdesk Case as `resolved`. The case must be in `pending` state to perform resolve operation. This operation requires no request body.' tags: - Helpdesk parameters: - name: id in: path required: true description: A unique value identifying this case. schema: type: string requestBody: content: application/json: {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.Case' examples: default: $ref: '#/components/examples/helpdesk.Case' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /modules/MD-0023/accounts/{account_id}/settings: get: operationId: helpdesk_MD_0023_account_retrieve_settings_getRetrieve_settingsAccountSettings description: Get the Helpdesk module settings for a given account. tags: - Helpdesk parameters: - name: account_id in: path required: true description: A unique value identifying this Account Settings. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.AccountSettings' examples: default: $ref: '#/components/examples/helpdesk.Settings' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' put: operationId: helpdesk_MD_0023_account_retrieve_settings_putChange_settingsAccountSettings description: Update the Helpdesk module settings for a given account. tags: - Helpdesk parameters: - name: account_id in: path required: true description: A unique value identifying this Account Settings. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/helpdesk.AccountSettings' examples: update_ttl: $ref: '#/components/examples/helpdesk.UpdateSettings-update_ttl' update_mode_and_instructions_builtin: $ref: '#/components/examples/helpdesk.UpdateSettings-update_mode_and_instructions_builtin' update_mode_and_instructions_federated: $ref: '#/components/examples/helpdesk.UpdateSettings-update_mode_and_instructions_federated' responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.AccountSettings' examples: default: $ref: '#/components/examples/helpdesk.Settings' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /modules/helpdesk/accounts/{account_id}/settings: get: operationId: helpdesk_helpdesk_account_retrieve_settings_getRetrieve_settingsAccountSettings description: Get the Helpdesk module settings for a given account. tags: - Helpdesk parameters: - name: account_id in: path required: true description: A unique value identifying this Account Settings. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.AccountSettings' examples: default: $ref: '#/components/examples/helpdesk.Settings' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' put: operationId: helpdesk_helpdesk_account_retrieve_settings_putChange_settingsAccountSettings description: Update the Helpdesk module settings for a given account. tags: - Helpdesk parameters: - name: account_id in: path required: true description: A unique value identifying this Account Settings. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/helpdesk.AccountSettings' examples: update_ttl: $ref: '#/components/examples/helpdesk.UpdateSettings-update_ttl' update_mode_and_instructions_builtin: $ref: '#/components/examples/helpdesk.UpdateSettings-update_mode_and_instructions_builtin' update_mode_and_instructions_federated: $ref: '#/components/examples/helpdesk.UpdateSettings-update_mode_and_instructions_federated' responses: '200': content: application/json: schema: $ref: '#/components/schemas/helpdesk.AccountSettings' examples: default: $ref: '#/components/examples/helpdesk.Settings' description: '' '400': $ref: '#/components/responses/helpdesk.any_400' /devops/event-definitions: get: operationId: eaas_event_definitions_list_listEventDefinitions description: Lists all available event definitions. tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.EventDefinition' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/event-definitions/{id}: get: operationId: eaas_event_definitions_detail_retrieveEventDefinition description: Retrieve a specific event definition for a given `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.EventDefinition' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/extensions: get: operationId: eaas_extensions_list_listCatalogExtensions description: Lists Extensions objects for the catalog with installation info for user. tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.CatalogExtension' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/extensions/{id}: get: operationId: eaas_extensions_detail_retrieveCatalogExtension description: Gets an Extension object given its `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.CatalogExtension' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/git/tags: post: operationId: eaas_git_tags_postTagsRepositoryTags description: 'Gets a list of tags that exist on the remote Extension Git repository. repository received as input. If the repository is not publicly available, credentials must be provided filling the `auth` node of the request payload.' tags: - DevOps parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.RepositoryTagsRequest' examples: withoutAuth: $ref: '#/components/examples/eaas.GetGitTagsRequest-withoutAuth' withAuth: $ref: '#/components/examples/eaas.GetGitTagsRequest-withAuth' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.RepositoryTags' examples: default: $ref: '#/components/examples/eaas.GetGitTagsResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/hubs: get: operationId: eaas_hubs_list_listHubReferences description: Gets the available hubs that could be used on a new extension. tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.HubReference' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/installations: get: operationId: eaas_installations_list_listInstallations description: Gets all the installations for the given user. tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: environment.extension.extension_id description: 'Filter for: environment.extension.extension_id **lookups:** eq, ne, like, ilike, null, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.extension.id description: 'Filter for: environment.extension.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.extension.name description: 'Filter for: environment.extension.name **lookups:** eq, ne, like, ilike, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.id description: 'Filter for: environment.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.type description: 'Filter for: environment.type **lookups:** eq, ne, like, ilike, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - production - test - development - name: events.installed.at description: 'Filter for: events.installed.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.installed.by.id description: 'Filter for: events.installed.by.id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: events.installed.by.name description: 'Filter for: events.installed.by.name **lookups:** eq, ne, like, ilike, 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, null, 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, 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, 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 **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: owner.role description: 'Filter for: owner.role **lookups:** eq, ne, like, ilike, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - vendor - distributor - reseller - 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: - installed - uninstalled responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Installation' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_installations_list_createInstallation description: Creates a new installation for the given extension and user. tags: - DevOps parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Installation' responses: '201': content: application/json: schema: $ref: '#/components/schemas/eaas.Installation' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/installations/{id}: get: operationId: eaas_installations_detail_retrieveInstallation description: Get the installation object for the given `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Installation' description: '' '400': $ref: '#/components/responses/eaas.any_400' put: operationId: eaas_installations_detail_updateInstallation description: Updates the installation object for the given `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: {} examples: default: $ref: '#/components/examples/eaas.UpdateInstallationSettingsRequest' responses: '200': content: application/json: schema: {} examples: default: $ref: '#/components/examples/eaas.InstallationResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/installations/{id}/uninstall: post: operationId: eaas_installations_uninstall_postUninstallInstallation description: Uninstall the installation given their `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Installation' examples: default: $ref: '#/components/examples/eaas.UninstallRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Installation' examples: default: $ref: '#/components/examples/eaas.InstallationResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/installations/{installation_id}/tasks: get: operationId: eaas_installation_tasks_list_listTasks description: Lists Task objects available in the collection given an `installation_id`. tags: - DevOps parameters: - name: installation_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: assignee description: 'Filter for: assignee **lookups:** eq, ne, like, ilike, null, 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.rescheduled.at description: 'Filter for: events.rescheduled.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' in: query required: false deprecated: false schema: type: string - name: object.category description: 'Filter for: object.category **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - background - interactive - scheduled - transformation - name: object.id description: 'Filter for: object.id **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: object.type description: 'Filter for: object.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: rescheduled_count description: 'Filter for: rescheduled_count **lookups:** eq, ne, ge, gt, le, lt, in, out **ordering:** true' in: query required: false deprecated: false schema: type: integer - name: runtime_max description: 'Filter for: runtime_max **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: number format: float - name: runtime_min description: 'Filter for: runtime_min **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: number format: float - name: runtime_total description: 'Filter for: runtime_total **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: number format: float - 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: - scheduled - rescheduled - processing - succeeded - failed - retrying - skipped responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Task' examples: default: $ref: '#/components/examples/eaas.TaskResponse-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/installations/{installation_id}/tasks/{id}: get: operationId: eaas_installation_tasks_detail_retrieveTask description: Gets a Task object given its `id` and an `installation_id`. tags: - DevOps parameters: - name: installation_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: $ref: '#/components/schemas/eaas.Task' examples: default: $ref: '#/components/examples/eaas.TaskResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/installations/{installation_id}/tasks/{id}/resubmit: post: operationId: eaas_installation_tasks_resubmit_postResubmitTask description: 'Resubmits a failed Task to the tasks processing queue given its `id` and an `installation_id`.' tags: - DevOps parameters: - name: installation_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: $ref: '#/components/schemas/eaas.Task' examples: default: $ref: '#/components/examples/eaas.TaskResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/invitations/redeem: post: operationId: eaas_invitation_redeem_postRedeemInvitation description: Redeem an invitation code, that means creating a new installation. tags: - DevOps parameters: - name: code in: query required: true description: Invitation code schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Invitation' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/invitations/{invitation_code}: get: operationId: eaas_invitation_detail_retrieveInvitation description: Retrieve an invitation for a given hash invitation code `invitation_code`. tags: - DevOps parameters: - name: invitation_code in: path required: true description: '' schema: type: string - name: code in: query required: true description: Invitation code schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Invitation' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/pages: get: operationId: eaas_pages_list_listUiPages description: Gets the available ui pages that could be displayed. tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: integration_point description: 'Filter for: integration_point **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - settings - devops - modules - admins - customer - name: label description: 'Filter for: label **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: service.title description: 'Filter for: service.title **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: tiers.id description: 'Filter for: tiers.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/eaas.UIPage' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/products: get: operationId: eaas_products_list_listProductReferences description: Gets the available products that could be used on a new extension. tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.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: 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/eaas.ProductReference' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/services: get: operationId: eaas_services_list_listExtensions description: Lists Extensions objects available in the collection. tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: environments.runtime description: 'Filter for: environments.runtime **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - local - cloud - 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: package_id description: 'Filter for: package_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 **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/eaas.Extension' examples: default: $ref: '#/components/examples/eaas.ServiceResponse-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_services_list_createExtension description: "Creates a new Extension for one or more given products as a Vendor,\n\ \ for a specific hub as a Distributor, multiaccount or transformations as\ \ a Vendor/Distributor\n /Reseller." tags: - DevOps parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Extension' examples: vendor: $ref: '#/components/examples/eaas.CreateServiceRequest-vendor' distributor: $ref: '#/components/examples/eaas.CreateServiceRequest-distributor' multiaccount: $ref: '#/components/examples/eaas.CreateServiceRequest-multiaccount' transformations: $ref: '#/components/examples/eaas.CreateServiceRequest-transformations' responses: '201': content: application/json: schema: $ref: '#/components/schemas/eaas.Extension' examples: default: $ref: '#/components/examples/eaas.ServiceResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/catalog-requests: get: operationId: eaas_service_catalog_requests_list_listCatalogRequests description: Lists Catalog requests objects available in the collection for a given `extension_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.CatalogRequest' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/catalog-requests/cancel: post: operationId: eaas_service_catalog_requests_cancel_postCancelCatalogRequest description: Cancel a publish or unpublish request of an Extension object given its `extension_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.CatalogRequest' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/catalog-requests/publish: post: operationId: eaas_service_catalog_requests_publish_postPublishCatalogRequest description: Request a publish of an Extension object given its `extension_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.CatalogRequest' examples: default: $ref: '#/components/examples/eaas.CatalogRequestPublishRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.CatalogRequest' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/catalog-requests/unpublish: post: operationId: eaas_service_catalog_requests_unpublish_postUnpublishCatalogRequest description: Request an unpublish of an Extension object given its `extension_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.CatalogRequest' examples: default: $ref: '#/components/examples/eaas.CatalogRequestUnpublishRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.CatalogRequest' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/catalog-requests/{id}: get: operationId: eaas_service_catalog_requests_detail_retrieveCatalogRequest description: Gets a Catalog request object given its `extension_id` and `id`. tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.CatalogRequest' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments: get: operationId: eaas_service_environments_list_listEnvironments description: Lists the Environment objects available for the given `extension_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.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: external_id description: 'Filter for: external_id **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: runtime description: 'Filter for: runtime **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - local - cloud - 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: - uninitialized - building - deploying - standby - running - upgrading - stopping - stopped - connected - disconnected - errored - 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: - production - test - development responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/events: get: operationId: eaas_service_environment_events_list_listEnvironmentEvents description: '' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.EnvironmentEvent' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/events/{id}: get: operationId: eaas_service_environment_events_detail_retrieveEnvironmentEvent description: '' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.EnvironmentEvent' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/instances/{id}: put: operationId: eaas_service_environment_instances_detail_updateInstance description: Update an Instance model. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Instance' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Instance' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/schedules: get: operationId: eaas_service_environment_schedules_list_listSchedules description: List Schedule objects for a given `extension_id` and `environment_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: description description: 'Filter for: description **lookups:** eq, ne, like, ilike, null, 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.last_triggered.at description: 'Filter for: events.last_triggered.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_trigger.at description: 'Filter for: events.next_trigger.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: method description: 'Filter for: method **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, 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 - obsolete - pending - 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: - onetime - recurring - advanced responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.ScheduleResponse-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_service_environment_schedules_list_createSchedule description: Create a new Schedule object for a given `extension_id` and `environment_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Schedule' examples: onetime: $ref: '#/components/examples/eaas.CreateScheduleRequest-onetime' recurring: $ref: '#/components/examples/eaas.CreateScheduleRequest-recurring' advanced: $ref: '#/components/examples/eaas.CreateScheduleRequest-advanced' responses: '201': content: application/json: schema: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.ScheduleResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/schedules/{id}: get: operationId: eaas_service_environment_schedules_detail_retrieveSchedule description: 'Retrieves a Schedule object given its `id`, `extension_id` and `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.ScheduleResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' put: operationId: eaas_service_environment_schedules_detail_updateSchedule description: 'Updates a Schedule object given its `id`, `extension_id` and `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.UpdateScheduleRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.ScheduleResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' delete: operationId: eaas_service_environment_schedules_detail_destroySchedule description: 'Delete a Schedule object given its `id`, `extension_id` and `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /devops/services/{extension_id}/environments/{environment_id}/schedules/{id}/disable: post: operationId: eaas_service_environment_schedules_disable_postDisableSchedule description: 'Disable a Schedule object given its `id`, `extension_id` and `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.ScheduleResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/schedules/{id}/enable: post: operationId: eaas_service_environment_schedules_enable_postEnableSchedule description: 'Enable a Schedule object given its `id`, `extension_id` and `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.ScheduleResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/schedules/{id}/trigger: post: operationId: eaas_service_environment_schedules_trigger_postTriggerSchedule description: 'Triggers the immediate execution of a Schedule object given its `id`, `extension_id` and `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.Schedule' examples: default: $ref: '#/components/examples/eaas.ScheduleResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/tasks: get: operationId: eaas_service_environment_tasks_list_listTasks description: 'Lists Task objects available in the collection given a `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: assignee description: 'Filter for: assignee **lookups:** eq, ne, like, ilike, null, 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.rescheduled.at description: 'Filter for: events.rescheduled.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' in: query required: false deprecated: false schema: type: string - name: object.category description: 'Filter for: object.category **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - background - interactive - scheduled - transformation - name: object.id description: 'Filter for: object.id **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: object.type description: 'Filter for: object.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: rescheduled_count description: 'Filter for: rescheduled_count **lookups:** eq, ne, ge, gt, le, lt, in, out **ordering:** true' in: query required: false deprecated: false schema: type: integer - name: runtime_max description: 'Filter for: runtime_max **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: number format: float - name: runtime_min description: 'Filter for: runtime_min **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: number format: float - name: runtime_total description: 'Filter for: runtime_total **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: number format: float - 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: - scheduled - rescheduled - processing - succeeded - failed - retrying - skipped responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Task' examples: default: $ref: '#/components/examples/eaas.TaskResponse-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_service_environment_tasks_list_createTask description: 'Create a Task object for given a `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Task' responses: '201': content: application/json: schema: $ref: '#/components/schemas/eaas.Task' examples: default: $ref: '#/components/examples/eaas.TaskResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/tasks/{id}: get: operationId: eaas_service_environment_tasks_detail_retrieveTask description: 'Gets a Task object given its `id` a `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.Task' examples: default: $ref: '#/components/examples/eaas.TaskResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/tasks/{id}/resubmit: post: operationId: eaas_service_environment_tasks_resubmit_postResubmitTask description: 'Resubmits a failed Task to the tasks processing queue given its `id` , an `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.Task' examples: default: $ref: '#/components/examples/eaas.TaskResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/transformations: get: operationId: eaas_service_environment_transformations_list_listTransformationFunctions description: "Lists TransformationFunction objects available in the collection\ \ given a `extension_id`\n and an `environment_id`." tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.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: method description: 'Filter for: method **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, 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' in: query required: false deprecated: false schema: type: string enum: - active - decommissioned responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.TransformationFunction' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/transformations/{id}: get: operationId: eaas_service_environment_transformations_detail_retrieveTransformationFunction description: "Retrieve a TransformationFunction object available in the collection\ \ given a\n `transformation_id`, `extension_id` and an `environment_id`." tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_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: $ref: '#/components/schemas/eaas.TransformationFunction' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/variables: get: operationId: eaas_service_environment_variables_list_listVariables description: 'Lists Variable objects available in the collection given an `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Variable' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_service_environment_variables_list_createVariable description: 'Creates a new Variable for a given `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Variable' examples: default: $ref: '#/components/examples/eaas.CreateVariableRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/eaas.Variable' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{environment_id}/variables/export: get: operationId: eaas_service_environment_variables_export_getExport_variablesVariable description: 'Export Variable objects to an Excel file from an Environment identified by an `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string responses: '200': content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: {} description: '' /devops/services/{extension_id}/environments/{environment_id}/variables/import: post: operationId: eaas_service_environment_variables_import_postImport_variablesVariable description: 'Import Variable objects from an Excel file into an Environment identified by an `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string requestBody: content: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: {} description: '' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Variable' description: '' /devops/services/{extension_id}/environments/{environment_id}/variables/{id}: put: operationId: eaas_service_environment_variables_detail_updateVariable description: 'Updates a Variable object given its `id`, an `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Variable' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Variable' description: '' '400': $ref: '#/components/responses/eaas.any_400' delete: operationId: eaas_service_environment_variables_detail_destroyVariable description: 'Deletes a Variable object given its `id`, an `extension_id` and an `environment_id`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: environment_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /devops/services/{extension_id}/environments/{id}: get: operationId: eaas_service_environments_detail_retrieveEnvironment description: Gets an Environment object given its `id` and `extension_id`. tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' put: operationId: eaas_service_environments_detail_updateEnvironment description: Updates an Environment object given its `id` and `extension_id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' examples: cloud: $ref: '#/components/examples/eaas.UpdateEnvironmentRequest-cloud' local: $ref: '#/components/examples/eaas.UpdateEnvironmentRequest-local' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/event-subscriptions: get: operationId: eaas_service_environments_event_subscriptions_getEvent_subscriptionsEnvironment description: 'Retrieve all the event subscriptions given an Environment `id` and `extension_id`.' tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/image: post: operationId: eaas_service_environments_image_postImageEnvironment description: Sets environment built image or build error. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/logs: get: operationId: eaas_service_environments_logs_getLogsEnvironment description: 'Gets a list of the Extension logs entries given an Environment `id` and `extension_id`. (`cloud` mode only).' tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.EnvironmentLogs' examples: default: $ref: '#/components/examples/eaas.EnvironmentLogsResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/logs-analytics/sso: get: operationId: eaas_service_environments_logs_analytics_sso_getLogs_analytics_ssoEnvironment description: 'Retrieves signed SAML2 assertion to do SSO with Logz.io logging service given an Environment `id` and `extension_id`. (`cloud` mode only).' tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.SamlResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/logs/set-level/{log_level}: post: operationId: eaas_service_environments_set_log_level_postLogs_levelEnvironment description: 'Sets the log level to capture logs of a running Extension given an Environment `id` and `extension_id`. (`cloud` mode only).' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string - name: log_level in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/rebuild: post: operationId: eaas_service_environments_rebuild_postRebuildEnvironment description: '' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/start: post: operationId: eaas_service_environments_start_postStartEnvironment description: "Deploys one or more Extension instances of an Environment\n given\ \ its `id` and `extension_id`. (`cloud` mode only)." tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/stats/{granularity}: get: operationId: eaas_service_environments_stats_getStatsEnvironment description: 'Retrieves statistics about health and resources consumption by the Extension instances given an Environment `id`, an `extension_id`, and a `granularity` (`cloud` mode only). The parameter `granularity` can be of three values: `hour`, `day` or `week`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string - name: granularity in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.EnvironmentMetrics' examples: default: $ref: '#/components/examples/eaas.EnvironmentStatsResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/stop: post: operationId: eaas_service_environments_stop_postStopEnvironment description: "Stop all running Extension instances of an Environment\n given\ \ its `id` and `extension_id`. (`cloud` mode only)." tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/task-stats/{granularity}: get: operationId: eaas_service_environments_task_stats_getTask_statsEnvironment description: 'Retrieves task statistics about health and resources consumption by the Extension instances given an Environment `id`, an `extension_id`, and a `granularity` (`cloud` mode only). The parameter `granularity` can be of three values: `hour`, `day` or `week`.' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string - name: granularity in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentTaskStatsResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/update: post: operationId: eaas_service_environments_update_version_postUpdate_versionEnvironment description: '' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/environments/{id}/update-config: post: operationId: eaas_service_environments_update_config_postUpdate_configEnvironment description: 'Updates the configuration (Variables) of the running Extension instances given an Environment `id` and `extension_id`.' tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Environment' examples: default: $ref: '#/components/examples/eaas.EnvironmentResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/installations: get: operationId: eaas_service_installations_list_listInstallations description: Gets all the installations for the given extension. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: environment.extension.extension_id description: 'Filter for: environment.extension.extension_id **lookups:** eq, ne, like, ilike, null, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.extension.id description: 'Filter for: environment.extension.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.extension.name description: 'Filter for: environment.extension.name **lookups:** eq, ne, like, ilike, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.id description: 'Filter for: environment.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string - name: environment.type description: 'Filter for: environment.type **lookups:** eq, ne, like, ilike, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - production - test - development - name: events.installed.at description: 'Filter for: events.installed.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.installed.by.id description: 'Filter for: events.installed.by.id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: events.installed.by.name description: 'Filter for: events.installed.by.name **lookups:** eq, ne, like, ilike, 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, null, 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, 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, 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 **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: owner.role description: 'Filter for: owner.role **lookups:** eq, ne, like, ilike, in, out **search:** true **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - vendor - distributor - reseller - 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: - installed - uninstalled responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.Installation' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/installations/{id}: get: operationId: eaas_service_installations_detail_retrieveInstallation description: Get the installation object for the given `id`. tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Installation' description: '' '400': $ref: '#/components/responses/eaas.any_400' put: operationId: eaas_service_installations_detail_updateInstallation description: Updates the installation object for the given `id`. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: {} examples: default: $ref: '#/components/examples/eaas.UpdateInstallationRequest' responses: '200': content: application/json: schema: {} examples: default: $ref: '#/components/examples/eaas.InstallationResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/installations/{id}/impersonate: post: operationId: eaas_service_installations_impersonate_postImpersonateInstallation description: '' tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string responses: '200': description: '' content: application/json: schema: properties: installation_api_key: type: string readOnly: true /devops/services/{extension_id}/invitations: get: operationId: eaas_service_invitations_list_listInvitations description: Gets all Invitation code objects for a given an `extension_id` Extension. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: environment.extension.id description: 'Filter for: environment.extension.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: environment.type description: 'Filter for: environment.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - production - test - development - name: events.accepted.at description: 'Filter for: events.accepted.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: 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: installation.id description: 'Filter for: installation.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: - invited - accepted - revoked - name: title description: 'Filter for: title **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/eaas.Invitation' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_service_invitations_list_createInvitation description: "Create an Invitation code object given an `extension_id` that\ \ could be used to install\n a new extension." tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.Invitation' examples: default: $ref: '#/components/examples/eaas.CreateInvitationRequest' responses: '201': content: application/json: schema: $ref: '#/components/schemas/eaas.Invitation' examples: default: $ref: '#/components/examples/eaas.CreateInvitationResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/invitations/{id}: get: operationId: eaas_service_invitations_detail_retrieveInvitation description: Gets an Invitation code object given its `external_id` and `id`. tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Invitation' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/invitations/{id}/revoke: post: operationId: eaas_service_invitations_revoke_postRevokeInvitation description: "Revoke an invited Invitation code object given an `extension_id`\ \ and `id` that has not\n been used or revoked." tags: - DevOps parameters: - name: extension_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: $ref: '#/components/schemas/eaas.Invitation' description: '' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{extension_id}/products: get: operationId: eaas_service_products_list_listProductReferences description: Gets the available products that could be used on a new extension. tags: - DevOps parameters: - name: extension_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.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: 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/eaas.ProductReference' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /devops/services/{id}: get: operationId: eaas_services_detail_retrieveExtension description: Gets a Extension object given its `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.Extension' examples: default: $ref: '#/components/examples/eaas.ServiceResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' put: operationId: eaas_services_detail_updateExtension description: Updates an Extension object given its `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: {} examples: default: $ref: '#/components/examples/eaas.UpdateServiceRequest' responses: '200': content: application/json: schema: {} examples: default: $ref: '#/components/examples/eaas.ServiceResponse' description: '' '400': $ref: '#/components/responses/eaas.any_400' delete: operationId: eaas_services_detail_destroyExtension description: Deletes an Extension object given its `id`. tags: - DevOps parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /devops/transformations: get: operationId: eaas_transformations_list_listTransformationFunctions description: "Gets all TransformationFunction objects visible for the account\ \ that is making the\n request." tags: - DevOps parameters: - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/eaas.RQLContentRangeLimitOffsetPagination.offset' - name: environment.extension.package description: 'Filter for: environment.extension.package **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: method description: 'Filter for: method **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, 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' in: query required: false deprecated: false schema: type: string enum: - active - decommissioned responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/eaas.TransformationFunction' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/eaas.any_400' /modules/MD-0024/settings/logs: get: operationId: eaas_module_id_settings_log_get_getRetrieveLogzAccount description: Gets the current Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' description: '' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_module_id_settings_log_get_postCreateLogzAccount description: Creates the Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' examples: default: $ref: '#/components/examples/eaas.CreateLogSettingRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' description: '' '400': $ref: '#/components/responses/eaas.any_400' put: operationId: eaas_module_id_settings_log_get_putUpdateLogzAccount description: Updates the Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' examples: default: $ref: '#/components/examples/eaas.CreateLogSettingRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' description: '' '400': $ref: '#/components/responses/eaas.any_400' delete: operationId: eaas_module_id_settings_log_get_deleteDestroyLogzAccount description: Deletes the Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] responses: '204': description: '' /modules/MD-0024/settings/logs/test: get: operationId: eaas_module_id_settings_log_test_getTestLogzAccount description: Test if the current setting is still valid. tags: - DevOps parameters: [] responses: '204': description: The settings are properly configured. '400': $ref: '#/components/responses/eaas.any_400' '404': description: The settings are not found. /modules/devops/settings/logs: get: operationId: eaas_eaas_settings_log_get_getRetrieveLogzAccount description: Gets the current Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' description: '' '400': $ref: '#/components/responses/eaas.any_400' post: operationId: eaas_eaas_settings_log_get_postCreateLogzAccount description: Creates the Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' examples: default: $ref: '#/components/examples/eaas.CreateLogSettingRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' description: '' '400': $ref: '#/components/responses/eaas.any_400' put: operationId: eaas_eaas_settings_log_get_putUpdateLogzAccount description: Updates the Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' examples: default: $ref: '#/components/examples/eaas.CreateLogSettingRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/eaas.LogzAccountArchivingConfig' description: '' '400': $ref: '#/components/responses/eaas.any_400' delete: operationId: eaas_eaas_settings_log_get_deleteDestroyLogzAccount description: Deletes the Logz account archiving setting for the user that is making the call. tags: - DevOps parameters: [] responses: '204': description: '' /modules/devops/settings/logs/test: get: operationId: eaas_eaas_settings_log_test_getTestLogzAccount description: Test if the current setting is still valid. tags: - DevOps parameters: [] responses: '204': description: The settings are properly configured. '400': $ref: '#/components/responses/eaas.any_400' '404': description: The settings are not found. /folders/{folder_type}/{folder_name}/files: get: operationId: media_file_list_listFiles description: '' tags: - Files parameters: - name: folder_type in: path required: true description: A type of the folder schema: type: string enum: - accounts - logos - favicons - eaas_icons - eaas_changelogs - helpdesk_attachment - helpdesk_preview - localization_task - news_images - pim_products - reports_report_file - streams_samples - streams_batches - streams_attachments - name: folder_name in: path required: true description: A name of the folder - an id of the related object schema: type: string examples: accounts - vendor: value: VA-001-001 accounts - distributor: value: PA-001-001 accounts - nested folders: value: VA-001-001/nested/folder - $ref: '#/components/parameters/media.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/media.RQLContentRangeLimitOffsetPagination.offset' - name: events.confirmed.at description: 'Filter for: events.confirmed.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.confirmed.by description: 'Filter for: events.confirmed.by **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 description: 'Filter for: events.created.by **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: mime_type description: 'Filter for: mime_type **lookups:** eq, ne, like, ilike, 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' 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: size description: 'Filter for: size **lookups:** eq, ne, ge, gt, le, lt, in, out' in: query required: false deprecated: false schema: type: integer responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/media.File' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/media.any_400' post: operationId: media_file_list_createFileCreate description: '' tags: - Files parameters: - name: folder_type in: path required: true description: A type of the folder schema: type: string enum: - accounts - logos - favicons - eaas_icons - eaas_changelogs - helpdesk_attachment - helpdesk_preview - localization_task - news_images - pim_products - reports_report_file - streams_samples - streams_batches - streams_attachments - name: folder_name in: path required: true description: A name of the folder - an id of the related object schema: type: string examples: accounts - vendor: value: VA-001-001 accounts - distributor: value: PA-001-001 accounts - nested folders: value: VA-001-001/nested/folder requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary preview: type: string format: binary access: type: object properties: account_id: type: object properties: view: type: boolean delete: type: boolean authenticated: type: object properties: view: type: boolean responses: '201': content: application/json: schema: $ref: '#/components/schemas/media.FileCreate' description: '' '400': $ref: '#/components/responses/media.any_400' /folders/{folder_type}/{folder_name}/files/import: post: operationId: media_file_import_postImport_fileFileImport description: '' tags: - Files parameters: - name: folder_type in: path required: true description: A type of the folder schema: type: string enum: - accounts - logos - favicons - eaas_icons - eaas_changelogs - helpdesk_attachment - helpdesk_preview - localization_task - news_images - pim_products - reports_report_file - streams_samples - streams_batches - streams_attachments - name: folder_name in: path required: true description: A name of the folder - an id of the related object schema: type: string examples: accounts - vendor: value: VA-001-001 accounts - distributor: value: PA-001-001 accounts - nested folders: value: VA-001-001/nested/folder requestBody: content: multipart/form-data: schema: properties: file: type: string format: binary account: type: object properties: id: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/media.FileImport' description: '' '400': $ref: '#/components/responses/media.any_400' /folders/{folder_type}/{folder_name}/files/{id}: get: operationId: media_file_detail_retrieveFile description: '' tags: - Files parameters: - name: folder_type in: path required: true description: A type of the folder schema: type: string enum: - accounts - logos - favicons - eaas_icons - eaas_changelogs - helpdesk_attachment - helpdesk_preview - localization_task - news_images - pim_products - reports_report_file - streams_samples - streams_batches - streams_attachments - name: folder_name in: path required: true description: A name of the folder - an id of the related object schema: type: string examples: accounts - vendor: value: VA-001-001 accounts - distributor: value: PA-001-001 accounts - nested folders: value: VA-001-001/nested/folder - name: id in: path required: true description: A unique value identifying this File. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/media.File' description: '' '400': $ref: '#/components/responses/media.any_400' put: operationId: media_file_detail_updateFileUpdate description: '' tags: - Files parameters: - name: folder_type in: path required: true description: A type of the folder schema: type: string enum: - accounts - logos - favicons - eaas_icons - eaas_changelogs - helpdesk_attachment - helpdesk_preview - localization_task - news_images - pim_products - reports_report_file - streams_samples - streams_batches - streams_attachments - name: folder_name in: path required: true description: A name of the folder - an id of the related object schema: type: string examples: accounts - vendor: value: VA-001-001 accounts - distributor: value: PA-001-001 accounts - nested folders: value: VA-001-001/nested/folder - name: id in: path required: true description: A unique value identifying this File. schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary preview: type: string format: binary access: type: object properties: account_id: type: object properties: view: type: boolean delete: type: boolean authenticated: type: object properties: view: type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/media.FileUpdate' description: '' '400': $ref: '#/components/responses/media.any_400' delete: operationId: media_file_detail_destroyFile description: '' tags: - Files parameters: - name: folder_type in: path required: true description: A type of the folder schema: type: string enum: - accounts - logos - favicons - eaas_icons - eaas_changelogs - helpdesk_attachment - helpdesk_preview - localization_task - news_images - pim_products - reports_report_file - streams_samples - streams_batches - streams_attachments - name: folder_name in: path required: true description: A name of the folder - an id of the related object schema: type: string examples: accounts - vendor: value: VA-001-001 accounts - distributor: value: PA-001-001 accounts - nested folders: value: VA-001-001/nested/folder - name: id in: path required: true description: A unique value identifying this File. schema: type: string responses: '204': description: '' /folders/{folder_type}/{folder_name}/files/{id}/{filename}: get: operationId: media_file_detail_filename_retrieveFile description: '' tags: - Files parameters: - name: folder_type in: path required: true description: A type of the folder schema: type: string enum: - accounts - logos - favicons - eaas_icons - eaas_changelogs - helpdesk_attachment - helpdesk_preview - localization_task - news_images - pim_products - reports_report_file - streams_samples - streams_batches - streams_attachments - name: folder_name in: path required: true description: A name of the folder - an id of the related object schema: type: string examples: accounts - vendor: value: VA-001-001 accounts - distributor: value: PA-001-001 accounts - nested folders: value: VA-001-001/nested/folder - name: id in: path required: true description: A unique value identifying this File. schema: type: string - name: filename in: path required: true description: A name of the File. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/media.File' description: '' '400': $ref: '#/components/responses/media.any_400' /partners/{partner_id}/categories: get: operationId: pim_partner_categories_list_listCategories description: '' tags: - PIM parameters: - name: partner_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - name: class.external_id description: 'Filter for: class.external_id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: class.id description: 'Filter for: class.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: class.name description: 'Filter for: class.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: depth description: 'Filter for: depth **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 **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: 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' in: query required: false deprecated: false schema: type: string - name: owner.name description: 'Filter for: owner.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: parent.external_id description: 'Filter for: parent.external_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 - name: parent.name description: 'Filter for: parent.name **lookups:** eq, ne, like, ilike, 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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.Category' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' /partners/{partner_id}/categories/{category_id}/products: get: operationId: pim_partner_category_products_list_listPartnerCategoryProductsViewSets description: '' tags: - PIM parameters: - name: partner_id in: path required: true description: '' schema: type: string - name: category_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/{partner_id}/categories/{category_id}/products/{pk}: get: operationId: pim_partner_category_products_detail_retrievePartnerCategoryProductsViewSet description: '' tags: - PIM parameters: - name: partner_id in: path required: true description: '' schema: type: string - name: category_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: type: array items: $ref: '#/components/schemas/dp.ProductVersion' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' /partners/{partner_id}/categories/{id}: get: operationId: pim_partner_categories_detail_retrieveCategory description: '' tags: - PIM parameters: - name: partner_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: $ref: '#/components/schemas/pim.Category' description: '' '400': $ref: '#/components/responses/pim.any_400' /pim/attributes: get: operationId: pim_attributes_list_listAttributes description: '' tags: - PIM parameters: - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - 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: group.external_id description: 'Filter for: group.external_id **lookups:** eq, ne, like, ilike, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.id description: 'Filter for: group.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.name description: 'Filter for: group.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' 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: 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: scope description: 'Filter for: scope **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - product - item - 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 - number - file - image responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.Attribute' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_attributes_list_createAttributeCreate description: '' tags: - PIM parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.AttributeCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.AttributeCreate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_attributes_list_destroyIdWrite description: '' tags: - PIM parameters: [] responses: '204': description: '' /pim/attributes/{id}: get: operationId: pim_attributes_detail_retrieveAttribute description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.Attribute' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_attributes_detail_updateAttributeUpdate description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.AttributeUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.AttributeUpdate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_attributes_detail_deleteDestroy_objectAttribute description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /pim/categories: get: operationId: pim_categories_list_listCategories description: '' tags: - PIM parameters: - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - name: class.external_id description: 'Filter for: class.external_id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: class.id description: 'Filter for: class.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: class.name description: 'Filter for: class.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: depth description: 'Filter for: depth **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 **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: 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' in: query required: false deprecated: false schema: type: string - name: owner.name description: 'Filter for: owner.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: parent.external_id description: 'Filter for: parent.external_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 - name: parent.name description: 'Filter for: parent.name **lookups:** eq, ne, like, ilike, 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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.Category' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_categories_list_createCategoryCreate description: '' tags: - PIM parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.CategoryCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.CategoryCreate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_categories_list_destroyIdWrite description: '' tags: - PIM parameters: [] responses: '204': description: '' /pim/categories/{id}: get: operationId: pim_categories_detail_retrieveCategory description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.Category' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_categories_detail_updateCategoryUpdate description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.CategoryUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.CategoryUpdate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_categories_detail_deleteDestroy_objectCategory description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /pim/classes: get: operationId: pim_classes_list_listClasses description: '' tags: - PIM parameters: - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - name: categories description: 'Filter for: categories **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: depth description: 'Filter for: depth **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 **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: 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: parent.external_id description: 'Filter for: parent.external_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 - name: parent.name description: 'Filter for: parent.name **lookups:** eq, ne, like, ilike, 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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.Class' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_classes_list_createClassCreate description: '' tags: - PIM parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.ClassCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.ClassCreate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_classes_list_destroyIdWrite description: '' tags: - PIM parameters: [] responses: '204': description: '' /pim/classes/{class_id}/attributes: get: operationId: pim_class_attributes_list_listClassAttributes description: '' tags: - PIM parameters: - name: class_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - 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: group.external_id description: 'Filter for: group.external_id **lookups:** eq, ne, like, ilike, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.id description: 'Filter for: group.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.name description: 'Filter for: group.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' 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: 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: scope description: 'Filter for: scope **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - product - item - 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 - number - file - image responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.ClassAttributeSerializerSpec' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_class_attributes_list_createIdWrite description: '' tags: - PIM parameters: - name: class_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.IdWrite' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.IdWrite' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_class_attributes_list_destroyIdWrite description: '' tags: - PIM parameters: - name: class_id in: path required: true description: '' schema: type: string responses: '204': description: '' /pim/classes/{class_id}/attributes/{id}: get: operationId: pim_class_attributes_detail_retrieveClassAttribute description: '' tags: - PIM parameters: - name: class_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: $ref: '#/components/schemas/pim.ClassAttributeSerializerSpec' description: '' '400': $ref: '#/components/responses/pim.any_400' /pim/classes/{class_id}/variants: get: operationId: pim_class_variants_list_listClassVariants description: '' tags: - PIM parameters: - name: class_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - name: attributes.id description: 'Filter for: attributes.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: attributes.name description: 'Filter for: attributes.name **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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.ClassVariantSerializerSpec' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_class_variants_list_createIdWrite description: '' tags: - PIM parameters: - name: class_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.IdWrite' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.IdWrite' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_class_variants_list_destroyIdWrite description: '' tags: - PIM parameters: - name: class_id in: path required: true description: '' schema: type: string responses: '204': description: '' /pim/classes/{class_id}/variants/{id}: get: operationId: pim_class_variants_detail_retrieveClassVariant description: '' tags: - PIM parameters: - name: class_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: $ref: '#/components/schemas/pim.ClassVariantSerializerSpec' description: '' '400': $ref: '#/components/responses/pim.any_400' /pim/classes/{id}: get: operationId: pim_classes_detail_retrieveClass description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.Class' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_classes_detail_updateClassUpdate description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.ClassUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.ClassUpdate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_classes_detail_deleteDestroy_objectClass description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /pim/groups: get: operationId: pim_groups_list_listGroups description: '' tags: - PIM parameters: - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - name: attributes description: 'Filter for: attributes **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - 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 **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: 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: stats.attributes description: 'Filter for: stats.attributes **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/pim.Group' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_groups_list_createGroupCreate description: '' tags: - PIM parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.GroupCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.GroupCreate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_groups_list_destroyIdWrite description: '' tags: - PIM parameters: [] responses: '204': description: '' /pim/groups/{group_id}/attributes: get: operationId: pim_group_attributes_list_listAttributes description: '' tags: - PIM parameters: - name: group_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - 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: group.external_id description: 'Filter for: group.external_id **lookups:** eq, ne, like, ilike, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.id description: 'Filter for: group.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.name description: 'Filter for: group.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' 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: 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: scope description: 'Filter for: scope **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - product - item - 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 - number - file - image responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.Attribute' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' /pim/groups/{group_id}/attributes/{id}: get: operationId: pim_group_attributes_detail_retrieveAttribute description: '' tags: - PIM parameters: - name: group_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: $ref: '#/components/schemas/pim.Attribute' description: '' '400': $ref: '#/components/responses/pim.any_400' /pim/groups/{id}: get: operationId: pim_groups_detail_retrieveGroup description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.Group' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_groups_detail_updateGroupUpdate description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.GroupUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.GroupUpdate' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_groups_detail_deleteDestroy_objectGroup description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /pim/variants: get: operationId: pim_variants_list_listVariants description: '' tags: - PIM parameters: - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - name: attributes.id description: 'Filter for: attributes.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: attributes.name description: 'Filter for: attributes.name **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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.Variant' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_variants_list_createVariantEdit description: '' tags: - PIM parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.VariantEdit' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.VariantEdit' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_variants_list_destroyIdWrite description: '' tags: - PIM parameters: [] responses: '204': description: '' /pim/variants/{id}: get: operationId: pim_variants_detail_retrieveVariant description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.Variant' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_variants_detail_updateVariantEdit description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.VariantEdit' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.VariantEdit' description: '' '400': $ref: '#/components/responses/pim.any_400' delete: operationId: pim_variants_detail_deleteDestroy_objectVariant description: '' tags: - PIM parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /products/{product_id}/items/{item_id}/taxonomies/{taxonomy_id}/attributes: get: operationId: pim_taxonomy_attributes_item_list_listClassAttributeWithValues description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: item_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - 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: group.external_id description: 'Filter for: group.external_id **lookups:** eq, ne, like, ilike, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.id description: 'Filter for: group.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.name description: 'Filter for: group.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' 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: 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: scope description: 'Filter for: scope **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - product - item - 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 - number - file - image responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.ClassAttributeWithValueSerializerSpec' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_taxonomy_attributes_item_list_putBulk_updateTaxonomyAttributeUpdateBulk description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: item_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: type: array items: type: object properties: id: type: string value: type: string responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.ClassAttributeWithValueSerializerSpec' description: '' '400': content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' /products/{product_id}/items/{item_id}/taxonomies/{taxonomy_id}/attributes/{attribute_id}: get: operationId: pim_taxonomy_attributes_item_detail_retrieveClassAttributeWithValue description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: item_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string - name: attribute_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.ClassAttributeWithValueSerializerSpec' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_taxonomy_attributes_item_detail_updateTaxonomyAttributeUpdate description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: item_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string - name: attribute_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.TaxonomyAttributeUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.TaxonomyAttributeUpdate' description: '' '400': $ref: '#/components/responses/pim.any_400' /products/{product_id}/taxonomies: get: operationId: pim_taxonomy_list_listTaxonomies description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.Taxonomy' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' post: operationId: pim_taxonomy_list_createTaxonomyCreate description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.TaxonomyCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/pim.TaxonomyCreate' description: '' '400': $ref: '#/components/responses/pim.any_400' /products/{product_id}/taxonomies/{id}: get: operationId: pim_taxonomy_detail_retrieveTaxonomy description: '' tags: - PIM parameters: - name: 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: $ref: '#/components/schemas/pim.Taxonomy' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_taxonomy_detail_updateTaxonomyUpdate description: '' tags: - PIM parameters: - name: 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: $ref: '#/components/schemas/pim.TaxonomyUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.TaxonomyUpdate' description: '' '400': $ref: '#/components/responses/pim.any_400' /products/{product_id}/taxonomies/{taxonomy_id}/attributes: get: operationId: pim_taxonomy_attributes_product_list_listClassAttributeWithValues description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/pim.RQL1000Pagination.limit' - $ref: '#/components/parameters/pim.RQL1000Pagination.offset' - 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: group.external_id description: 'Filter for: group.external_id **lookups:** eq, ne, like, ilike, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.id description: 'Filter for: group.id **lookups:** eq, ne, like, ilike, null, in, out **search:** true' in: query required: false deprecated: false schema: type: string - name: group.name description: 'Filter for: group.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' 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: 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: scope description: 'Filter for: scope **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - product - item - 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 - number - file - image responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.ClassAttributeWithValueSerializerSpec' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_taxonomy_attributes_product_list_putBulk_updateTaxonomyAttributeUpdateBulk description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: type: array items: type: object properties: id: type: string value: type: string responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/pim.ClassAttributeWithValueSerializerSpec' description: '' '400': content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' /products/{product_id}/taxonomies/{taxonomy_id}/attributes/{attribute_id}: get: operationId: pim_taxonomy_attributes_product_detail_retrieveClassAttributeWithValue description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string - name: attribute_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.ClassAttributeWithValueSerializerSpec' description: '' '400': $ref: '#/components/responses/pim.any_400' put: operationId: pim_taxonomy_attributes_product_detail_updateTaxonomyAttributeUpdate description: '' tags: - PIM parameters: - name: product_id in: path required: true description: '' schema: type: string - name: taxonomy_id in: path required: true description: '' schema: type: string - name: attribute_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/pim.TaxonomyAttributeUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/pim.TaxonomyAttributeUpdate' description: '' '400': $ref: '#/components/responses/pim.any_400' /brand: get: operationId: branding_brand_listBrands description: '' tags: - Brands parameters: [] responses: '200': content: application/json: schema: type: array items: {} description: '' '400': $ref: '#/components/responses/branding.any_400' /brands: get: operationId: branding_brands_list_listBrands description: '' tags: - Brands parameters: - $ref: '#/components/parameters/branding.RQL1000Pagination.limit' - $ref: '#/components/parameters/branding.RQL1000Pagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/branding.Brand' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/branding.any_400' post: operationId: branding_brands_list_createBrand description: '' tags: - Brands parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/branding.Brand' responses: '201': content: application/json: schema: $ref: '#/components/schemas/branding.Brand' description: '' '400': $ref: '#/components/responses/branding.any_400' /brands/{brand_pk}/portals: get: operationId: branding_brand_portals_list_listPortals description: '' tags: - Portals parameters: - name: brand_pk in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/branding.RQL1000Pagination.limit' - $ref: '#/components/parameters/branding.RQL1000Pagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/branding.Portal' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/branding.any_400' post: operationId: branding_brand_portals_list_createPortal description: '' tags: - Portals parameters: - name: brand_pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/branding.Portal' responses: '201': content: application/json: schema: $ref: '#/components/schemas/branding.Portal' description: '' '400': $ref: '#/components/responses/branding.any_400' /brands/{brand_pk}/portals/{id}: get: operationId: branding_brand_portals_detail_retrievePortal description: '' tags: - Portals parameters: - name: brand_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/branding.Portal' description: '' '400': $ref: '#/components/responses/branding.any_400' put: operationId: branding_brand_portals_detail_updatePortal description: '' tags: - Portals parameters: - name: brand_pk in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/branding.Portal' responses: '200': content: application/json: schema: $ref: '#/components/schemas/branding.Portal' description: '' '400': $ref: '#/components/responses/branding.any_400' delete: operationId: branding_brand_portals_detail_destroyPortal description: '' tags: - Portals parameters: - name: brand_pk in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /brands/{id}: put: operationId: branding_brands_detail_updateBrand description: '' tags: - Brands parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/branding.Brand' responses: '200': content: application/json: schema: $ref: '#/components/schemas/branding.Brand' description: '' '400': $ref: '#/components/responses/branding.any_400' /domains/{id}: get: operationId: branding_domains_detail_retrieveDomain description: '' tags: - Domains parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/branding.Domain' description: '' '400': $ref: '#/components/responses/branding.any_400' put: operationId: branding_domains_detail_updateDomain description: '' tags: - Domains parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/branding.Domain' responses: '200': content: application/json: schema: $ref: '#/components/schemas/branding.Domain' description: '' '400': $ref: '#/components/responses/branding.any_400' delete: operationId: branding_domains_detail_destroyDomain description: '' tags: - Domains parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /domains/{id}/verify: post: operationId: branding_domains_verify_postVerifyDomain description: '' tags: - Domains parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/branding.Domain' responses: '200': content: application/json: schema: $ref: '#/components/schemas/branding.Domain' description: '' '400': $ref: '#/components/responses/branding.any_400' /portal: get: operationId: branding_portal_listPortals description: Get a portal details by headers tags: - Portals parameters: [] responses: '200': content: application/json: schema: type: array items: {} description: '' '400': $ref: '#/components/responses/branding.any_400' /sla: get: operationId: slm_sla_list_listSlas description: Lists SLA objects available in the collection. tags: - SLM parameters: - $ref: '#/components/parameters/slm.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/slm.RQLContentRangeLimitOffsetPagination.offset' - name: active description: 'Filter for: active **lookups:** eq, ne' in: query required: false deprecated: false schema: type: boolean - name: entity_type description: 'Filter for: entity_type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - subscription_request - tier_config_request - 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 responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/slm.ServiceLevelAgreement' examples: default: $ref: '#/components/examples/slm.Sla-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/slm.any_400' /sla/{id}: get: operationId: slm_sla_detail_retrieveSLA description: Get a particular SLA object given its id. tags: - SLM parameters: - name: id in: path required: true description: A unique value identifying this Service Level Agreement. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/slm.ServiceLevelAgreement' examples: default: $ref: '#/components/examples/slm.Sla' description: '' '400': $ref: '#/components/responses/slm.any_400' put: operationId: slm_sla_detail_updateSLA description: Update SLA settings. tags: - SLM parameters: - name: id in: path required: true description: A unique value identifying this Service Level Agreement. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/slm.ServiceLevelAgreement' examples: change_sla_active: $ref: '#/components/examples/slm.UpdateSla-change_sla_active' change_sla_slo: $ref: '#/components/examples/slm.UpdateSla-change_sla_slo' responses: '200': content: application/json: schema: $ref: '#/components/schemas/slm.ServiceLevelAgreement' examples: default: $ref: '#/components/examples/slm.Sla' description: '' '400': $ref: '#/components/responses/slm.any_400' /sli: get: operationId: slm_sli_list_listSlis description: Lists SLI objects available in the collection. tags: - SLM parameters: - $ref: '#/components/parameters/slm.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/slm.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/slm.ServiceLevelIndicator' examples: default: $ref: '#/components/examples/slm.Sli-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/slm.any_400' /sli/{id}: get: operationId: slm_sli_detail_retrieveSLI description: Get a particular SLI object given its id or by an id of tracked entity. tags: - SLM parameters: - name: id in: path required: true description: A unique value identifying this Service Level Indicator. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/slm.ServiceLevelIndicator' examples: default: $ref: '#/components/examples/slm.Sli' description: '' '400': $ref: '#/components/responses/slm.any_400' /localization/contexts: get: operationId: localization_contexts_list_listLocalizationContexts description: Lists the Localization Context objects registered in the system tags: - Localization parameters: - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/localization.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: instance_id description: 'Filter for: instance_id **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, 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: - product - pim responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/localization.LocalizationContext' examples: GET: $ref: '#/components/examples/localization.LocalizationContext-GET-list' GET-extended: $ref: '#/components/examples/localization.LocalizationContext-GET-extended-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/localization.any_400' post: operationId: localization_contexts_list_createLocalizationContext description: 'Creates new Localization Context object. **WARNING! The creation of Localization Context object 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 Localization Context objects but will not be able to create new Localization Context object.**' tags: - Localization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/localization.LocalizationContext' examples: default: $ref: '#/components/examples/localization.CreateLocalizationContext' responses: '201': content: application/json: schema: $ref: '#/components/schemas/localization.LocalizationContext' examples: default: $ref: '#/components/examples/localization.LocalizationContextCreateResp' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/contexts/{id}: get: operationId: localization_contexts_detail_retrieveLocalizationContext description: Gets a Localization Context object details given its `id` tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.LocalizationContext' examples: default: $ref: '#/components/examples/localization.GetLocalizationContext' description: '' '400': $ref: '#/components/responses/localization.any_400' delete: operationId: localization_contexts_detail_destroyLocalizationContext description: 'Deletes a Localization Context object given its `id`. **WARNING! The deletion of Localization Context object 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 Localization Context objects but will not be able to delete Localization Context object.**' tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /localization/locales: get: operationId: localization_locales_list_listLocales description: Lists the Locale objects registered in the system tags: - Localization parameters: - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.offset' - name: auto_translation description: 'Filter for: auto_translation **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: local_name description: 'Filter for: local_name **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: marketplaces.id description: 'Filter for: marketplaces.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: marketplaces.name description: 'Filter for: marketplaces.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 **ordering:** true' in: query required: false deprecated: false schema: type: string - name: stats.pim_translations description: 'Filter for: stats.pim_translations **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: integer - name: stats.translations description: 'Filter for: stats.translations **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/localization.Locale' examples: GET: $ref: '#/components/examples/localization.Locale-GET-list' GET-Extended: $ref: '#/components/examples/localization.Locale-GET-Extended-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/localization.any_400' /localization/locales/{id}: get: operationId: localization_locales_detail_retrieveLocale description: Gets a Locale object given its `id` tags: - Localization parameters: - name: id in: path required: true description: A unique value identifying this Locale. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.Locale' examples: default: $ref: '#/components/examples/localization.LocaleRetrieveResponse' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/translations: get: operationId: localization_translations_list_listTranslations description: 'Lists the Translation objects available for the actor These translations may or may not be owned by the actor. If actor is not the owner it must have the translation be made visible by the parent. Vendor actor can see only its own translations. Distributor actor may see Vendor''s translations and its own. Reseller actor may see all translations in the chain (of Vendor, of Distributor) and its own' tags: - Localization parameters: - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.offset' - name: auto.enabled description: 'Filter for: auto.enabled **lookups:** eq, ne **ordering:** true' in: query required: false deprecated: false schema: type: boolean - name: auto.status description: 'Filter for: auto.status **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - 'off' - 'on' - processing - error - name: context.id description: 'Filter for: context.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: context.instance_id description: 'Filter for: context.instance_id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: context.name description: 'Filter for: context.name **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: context.type description: 'Filter for: context.type **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - product - pim - name: description description: 'Filter for: description **lookups:** eq, ne, like, ilike, null, 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: locale.id description: 'Filter for: locale.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: locale.name description: 'Filter for: locale.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 **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 **ordering:** true' in: query required: false deprecated: false schema: type: string - name: primary description: 'Filter for: primary **lookups:** eq, ne **ordering:** true' in: query required: false deprecated: false schema: type: boolean - name: status description: 'Filter for: status **lookups:** eq **ordering:** true' in: query required: false deprecated: false schema: type: string responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/localization.any_400' post: operationId: localization_translations_list_createTranslation description: Creates new Translation object or multiple objects tags: - Localization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: new_translation: $ref: '#/components/examples/localization.CreateTranslation-new_translation' new_bulk_translation: $ref: '#/components/examples/localization.CreateTranslation-new_bulk_translation' responses: '201': content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' put: operationId: localization_translations_list_putBulk_updateTranslationBulkUpdate description: 'Updates multiple Translation objects given its `ids`. Actor can only update translations which are owned by it' tags: - Localization parameters: [] requestBody: content: application/json: schema: {} examples: default: $ref: '#/components/examples/localization.UpdateTranslationsBulk' responses: '200': content: application/json: schema: {} examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' delete: operationId: localization_translations_list_deleteBulk_destroyTranslation description: 'Deletes multiple existing Translation objects given its `ids`. Actor can only delete translations which are owned by it' tags: - Localization parameters: [] responses: '204': description: '' /localization/translations/{id}: get: operationId: localization_translations_detail_retrieveTranslation description: 'Gets a Translation given its `id`. Visibility of translation may be restricted by the parent. Parent for Reseller is Distributor, and parent for Distributor is Vendor.' tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' put: operationId: localization_translations_detail_updateTranslation description: 'updates a Translation object given its `id`. Actor can only update translations which are owned by it' tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.UpdateTranslation' responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' delete: operationId: localization_translations_detail_destroyTranslation description: 'Deletes an existing Translation object. Actor can only delete translations which are owned by it' tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /localization/translations/{id}/activate: post: operationId: localization_translations_activate_postActivateTranslation description: 'Makes current Translation active within the scope of the owner of the translation and it''s children. To make the Translation Active, the actor who does API request must be the owner of such translation. For example, if Reseller makes translation active, it will become active only in scope of Reseller. If the Distributor makes it active, it will become active in scope of the Distributor and all of its Resellers (in case if Reseller does not have any other Translation active of the same Locale which belongs to him). If Vendor makes it active, then it will become active for all of its Distributor and for each Reseller of Distributors (in case if Distributor(s) and/or Reseller(s) do not have any other Translation active of the same Locale which belongs to them)' tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/translations/{id}/clone: post: operationId: localization_translations_clone_postCloneTranslation description: 'Clones current translation into a new one. Owner of such new translation is the actor who is doing the action. By default, it is created as inactive and not primary' tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/translations/{id}/primarize: post: operationId: localization_translations_primarize_postPrimarizeTranslation description: 'Makes current translation a primary one. Actor must be the owner of such translation. Existing primary translation becomes not primary after this action. Translation attributes are being synced from current primary to the one we are making primary at this moment' tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/translations/{id}/retry: post: operationId: localization_translations_retry_postRetryTranslation description: Retries the auto-translation for the Translation which has the last attempt failed tags: - Localization parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/localization.Translation' responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.Translation' examples: default: $ref: '#/components/examples/localization.Translation' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/translations/{translation_id}/attributes: get: operationId: localization_translation_attributes_list_listTranslationAttributes description: 'Lists the Translation Attribute objects available for the translation. In case if `GET` request is done with `Accept` header set to `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, the endpoint will not return JSON collection but rather Excel binary data. Such request means export of translation attributes in Excel format is requested.' tags: - Localization parameters: - name: translation_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.offset' - name: auto_translated description: 'Filter for: auto_translated **lookups:** eq, ne **ordering:** true' in: query required: false deprecated: false schema: type: boolean - name: comment description: 'Filter for: comment **lookups:** eq, ne, like, ilike, null, 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: key description: 'Filter for: key **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: object.id description: 'Filter for: object.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: object.model description: 'Filter for: object.model **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, null, 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/localization.TranslationAttribute' examples: default: $ref: '#/components/examples/localization.TranslationAttribute-list' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/localization.any_400' put: operationId: localization_translation_attributes_list_putBulk_updateTranslationAttributeBulkUpdate description: 'Updates multiple Translation Attribute objects given its `keys`. For this operation you can either send array of JSON objects as specified in the example or you can also upload Excel XLSX file (MIME type: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`). Before uploading perform the export operation, edit Excel file accordingly and then upload it back. Please be sure to specify the `Content-Type` header as `multipart/form-data`, the `Content-Length` headers with the correct data size and the `Content-Disposition` header as `attachment; filename=some_name.xlsx`. The body of the request must be a `form-data` body with the key `file` and value -- **base64 encoded** string of the binary content. Excel file which you import should have exactly the same structure as the exported file earlier, you can only modify there `value` and `comment` columns on the `Attributes` sheet. **CURL** example: `curl -L -X PUT https://../public/v1/localization/{translation_id}/attributes` `-H "Authorization: ApiKey ...:..." -H "Content-Disposition: attachment;` `filename=some_name.xlsx" --form file=@"/path/to/file/file.xlsx"`' tags: - Localization parameters: - name: translation_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: {} examples: default: $ref: '#/components/examples/localization.UpdateBulk' application/vnd.openxmlformats-officedocument.spreadsheetml.sheet: schema: type: string format: binary responses: '200': content: application/json: schema: {} examples: default: $ref: '#/components/examples/localization.TranslationAttribute' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/translations/{translation_id}/attributes/{key}: get: operationId: localization_translation_attributes_detail_retrieveTranslationAttribute description: Gets a Translation Attribute given its `key` tags: - Localization parameters: - name: translation_id in: path required: true description: '' schema: type: string - name: key in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.TranslationAttribute' examples: default: $ref: '#/components/examples/localization.TranslationAttribute' description: '' '400': $ref: '#/components/responses/localization.any_400' put: operationId: localization_translation_attributes_detail_updateTranslationAttribute description: Update `value` and/or `comment` of the specific Translation Attribute tags: - Localization parameters: - name: translation_id in: path required: true description: '' schema: type: string - name: key in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/localization.TranslationAttribute' examples: default: $ref: '#/components/examples/localization.Update' responses: '200': content: application/json: schema: $ref: '#/components/schemas/localization.TranslationAttribute' examples: default: $ref: '#/components/examples/localization.TranslationAttribute' description: '' '400': $ref: '#/components/responses/localization.any_400' /localization/translations/{translation_id}/tasks: get: operationId: localization_translation_tasks_list_listTranslationTasks description: Lists the Translation Task objects registered for the translation tags: - Localization parameters: - name: translation_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/localization.RQLContentRangeLimitOffsetPagination.offset' - 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: 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: 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 - success - processing - error - 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: - attributes_autotranslation responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/localization.TranslationTask' examples: default: $ref: '#/components/examples/localization.TranslationTask-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/localization.any_400' /localization/translations/{translation_id}/tasks/{id}: get: operationId: localization_translation_tasks_detail_retrieveTranslationTask description: Gets a Translation Task object given its `id` tags: - Localization parameters: - name: translation_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: $ref: '#/components/schemas/localization.TranslationTask' examples: default: $ref: '#/components/examples/localization.TranslationTask' description: '' '400': $ref: '#/components/responses/localization.any_400' /billing/batches: get: operationId: streams_billing_batch_list_listBillingBatches description: '' tags: - Streams parameters: - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: context description: 'Filter for: context **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: context.period.end description: 'Filter for: context.period.end **lookups:** eq, ne, ge, gt, le, lt, in, out' in: query required: false deprecated: false schema: type: string format: date-time - name: context.period.start description: 'Filter for: context.period.start **lookups:** eq, ne, ge, gt, le, lt, in, out' in: query required: false deprecated: false schema: type: string format: date-time - name: events description: 'Filter for: events **lookups:** eq, ne, like, ilike, in, out **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: 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' in: query required: false deprecated: false schema: type: string - name: source.id description: 'Filter for: source.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stats description: 'Filter for: stats **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, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - draft - processing - published - failed - deleted - name: stream.context description: 'Filter for: stream.context **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: stream.context.account.id description: 'Filter for: stream.context.account.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.account.name description: 'Filter for: stream.context.account.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.listing.id description: 'Filter for: stream.context.listing.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.id description: 'Filter for: stream.context.marketplace.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.name description: 'Filter for: stream.context.marketplace.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.id description: 'Filter for: stream.context.product.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.name description: 'Filter for: stream.context.product.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.id description: 'Filter for: stream.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.owner.id description: 'Filter for: stream.owner.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: task.status description: 'Filter for: task.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - pending - processing - success - failed - name: test description: 'Filter for: test **lookups:** eq, ne, null' in: query required: false deprecated: false schema: type: boolean responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.BillingBatch' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' post: operationId: streams_billing_batch_list_createBillingBatchCreate description: '' tags: - Streams parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingBatchCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/streams.BillingBatchCreate' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/batches/{batch_id}/files: get: operationId: streams_billing_files_list_listBatchFiles description: '' tags: - Streams parameters: - name: batch_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: type description: 'Filter for: type **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - input - output responses: '200': content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string type: type: string position: type: integer description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' post: operationId: streams_billing_files_list_createBatchFileCreate description: '' tags: - Streams parameters: - name: batch_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BatchFileCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/streams.BatchFileCreate' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/batches/{id}: get: operationId: streams_billing_batch_detail_retrieveBillingBatch description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingBatch' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_billing_batch_detail_updateBatchUpdate description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BatchUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BatchUpdate' description: '' '400': $ref: '#/components/responses/streams.any_400' delete: operationId: streams_billing_batch_detail_destroyBillingBatch description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /billing/batches/{id}/process: post: operationId: streams_billing_batch_process_postProcessBillingBatch description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingBatch' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingBatch' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/requests: get: operationId: streams_billing_request_list_listBillingTransformationRequests description: '' tags: - Streams parameters: - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: assignee.id description: 'Filter for: assignee.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: batch.context.period.end description: 'Filter for: batch.context.period.end **lookups:** eq, ne, ge, gt, le, lt, in, out' in: query required: false deprecated: false schema: type: string format: date-time - name: batch.context.period.start description: 'Filter for: batch.context.period.start **lookups:** eq, ne, ge, gt, le, lt, in, out' in: query required: false deprecated: false schema: type: string format: date-time - name: batch.id description: 'Filter for: batch.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: batch.name description: 'Filter for: batch.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: events description: 'Filter for: events **lookups:** eq, ne, like, ilike, in, out **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.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: stats description: 'Filter for: stats **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, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - scheduled - pending - completed - published - failed - canceled - name: stream.context.account.id description: 'Filter for: stream.context.account.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.account.name description: 'Filter for: stream.context.account.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.listing.id description: 'Filter for: stream.context.listing.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.id description: 'Filter for: stream.context.marketplace.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.name description: 'Filter for: stream.context.marketplace.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.id description: 'Filter for: stream.context.product.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.name description: 'Filter for: stream.context.product.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.id description: 'Filter for: stream.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.name description: 'Filter for: stream.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.owner.id description: 'Filter for: stream.owner.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: transformation.columns description: 'Filter for: transformation.columns **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: transformation.description description: 'Filter for: transformation.description **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: transformation.function.id description: 'Filter for: transformation.function.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: transformation.function.manual description: 'Filter for: transformation.function.manual **lookups:** eq, ne, null' in: query required: false deprecated: false schema: type: boolean - name: transformation.position description: 'Filter for: transformation.position **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: integer - name: validation.status description: 'Filter for: validation.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - pending - processing - success - failed responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.BillingTransformationRequest' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' /billing/requests/{pk}: get: operationId: streams_billing_request_detail_retrieveBillingTransformationRequest description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingTransformationRequest' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_billing_request_detail_updateTransformationRequestUpdate description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequestUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequestUpdate' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/requests/{pk}/fail: post: operationId: streams_billing_request_fail_postFailTransformationRequestFail description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequestFail' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequest' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/requests/{pk}/process: post: operationId: streams_billing_request_process_postProcessBillingTransformationRequest description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingTransformationRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingTransformationRequest' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/streams: get: operationId: streams_billing_stream_list_listBillingStreams description: '' tags: - Streams parameters: - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: context description: 'Filter for: context **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: context.account.id description: 'Filter for: context.account.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.account.name description: 'Filter for: context.account.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: context.listing.id description: 'Filter for: context.listing.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.marketplace.id description: 'Filter for: context.marketplace.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.marketplace.name description: 'Filter for: context.marketplace.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: context.product.id description: 'Filter for: context.product.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.product.name description: 'Filter for: context.product.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: events description: 'Filter for: events **lookups:** eq, ne, like, ilike, in, out **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 **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' in: query required: false deprecated: false schema: type: string - name: samples description: 'Filter for: samples **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: sources.id description: 'Filter for: sources.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: sources.samples description: 'Filter for: sources.samples **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, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - configuring - active - terminated - deleted - name: validation.status description: 'Filter for: validation.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - draft - processing - published - failed - deleted - name: visibility description: 'Filter for: visibility **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - private - published responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.BillingStream' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' post: operationId: streams_billing_stream_list_createBillingStreamWrite description: '' tags: - Streams parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingStreamWrite' responses: '201': content: application/json: schema: $ref: '#/components/schemas/streams.BillingStreamWrite' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/streams/{pk}: get: operationId: streams_billing_stream_detail_retrieveBillingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_billing_stream_detail_updateBillingStreamWrite description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingStreamWrite' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingStreamWrite' description: '' '400': $ref: '#/components/responses/streams.any_400' delete: operationId: streams_billing_stream_detail_destroyBillingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string responses: '204': description: '' /billing/streams/{pk}/activate: post: operationId: streams_billing_stream_activate_postActivateBillingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/streams/{pk}/configure: post: operationId: streams_billing_stream_configure_postConfigureBillingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/streams/{pk}/terminate: post: operationId: streams_billing_stream_terminate_postTerminateBillingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/streams/{pk}/validate: post: operationId: streams_billing_stream_validate_postValidateBillingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BillingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/streams/{stream_pk}/columns: get: operationId: streams_billing_columns_list_listColumns description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: name description: 'Filter for: name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: origin.id description: 'Filter for: origin.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: origin.position description: 'Filter for: origin.position **lookups:** eq, ne, ge, gt, le, lt, null, in, out' in: query required: false deprecated: false schema: type: integer - name: output description: 'Filter for: output **lookups:** eq, ne' in: query required: false deprecated: false schema: type: boolean responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.Column' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' /billing/streams/{stream_pk}/columns/{verbose_id}: get: operationId: streams_billing_columns_detail_retrieveColumn description: '' tags: - Streams parameters: - name: stream_pk 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/streams.Column' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_billing_columns_detail_updateColumnUpdate description: '' tags: - Streams parameters: - name: stream_pk 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/streams.ColumnUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.ColumnUpdate' description: '' '400': $ref: '#/components/responses/streams.any_400' /billing/streams/{stream_pk}/transformations: get: operationId: streams_billing_transformations_list_listTransformations description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: columns description: "Filter for: columns\n\n**lookups:** \n\n**default:** *hidden*" in: query required: false deprecated: false schema: type: string - name: function.manual description: 'Filter for: function.manual **lookups:** eq, ne, null **default:** *hidden*' in: query required: false deprecated: false schema: type: boolean responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object post: operationId: streams_billing_transformations_list_createTransformationWrite description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: type: object properties: function: type: object properties: id: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean settings: type: object gravity: type: object responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 201: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object /billing/streams/{stream_pk}/transformations/{verbose_id}: get: operationId: streams_billing_transformations_detail_retrieveTransformation description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - name: verbose_id in: path required: true description: '' schema: type: string responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object put: operationId: streams_billing_transformations_detail_updateTransformationWrite description: '' tags: - Streams parameters: - name: stream_pk 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: function: type: object properties: id: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean settings: type: object gravity: type: object responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object delete: operationId: streams_billing_transformations_detail_destroyTransformation description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - name: verbose_id in: path required: true description: '' schema: type: string responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object /pricing/batches: get: operationId: streams_pricing_batch_list_listPricingBatches description: '' tags: - Streams parameters: - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: context description: 'Filter for: context **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: context.pricelist_version.id description: 'Filter for: context.pricelist_version.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.pricelist_version.start_at description: 'Filter for: context.pricelist_version.start_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: context.pricelist_version.status description: 'Filter for: context.pricelist_version.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: events description: 'Filter for: events **lookups:** eq, ne, like, ilike, in, out **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: 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' in: query required: false deprecated: false schema: type: string - name: source.id description: 'Filter for: source.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stats description: 'Filter for: stats **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, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - draft - processing - published - failed - deleted - name: stream.context description: 'Filter for: stream.context **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: stream.context.account.id description: 'Filter for: stream.context.account.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.account.name description: 'Filter for: stream.context.account.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.listing.id description: 'Filter for: stream.context.listing.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.id description: 'Filter for: stream.context.marketplace.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.name description: 'Filter for: stream.context.marketplace.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.pricelist.id description: 'Filter for: stream.context.pricelist.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.id description: 'Filter for: stream.context.product.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.name description: 'Filter for: stream.context.product.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.id description: 'Filter for: stream.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.owner.id description: 'Filter for: stream.owner.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: task.status description: 'Filter for: task.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - pending - processing - success - failed - name: test description: 'Filter for: test **lookups:** eq, ne, null' in: query required: false deprecated: false schema: type: boolean responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.PricingBatch' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' post: operationId: streams_pricing_batch_list_createPricingBatchCreate description: '' tags: - Streams parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingBatchCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/streams.PricingBatchCreate' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/batches/{batch_id}/files: get: operationId: streams_pricing_files_list_listBatchFiles description: '' tags: - Streams parameters: - name: batch_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: type description: 'Filter for: type **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - input - output responses: '200': content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string type: type: string position: type: integer description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' post: operationId: streams_pricing_files_list_createBatchFileCreate description: '' tags: - Streams parameters: - name: batch_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BatchFileCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/streams.BatchFileCreate' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/batches/{id}: get: operationId: streams_pricing_batch_detail_retrievePricingBatch description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingBatch' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_pricing_batch_detail_updateBatchUpdate description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.BatchUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.BatchUpdate' description: '' '400': $ref: '#/components/responses/streams.any_400' delete: operationId: streams_pricing_batch_detail_destroyPricingBatch description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /pricing/batches/{id}/process: post: operationId: streams_pricing_batch_process_postProcessPricingBatch description: '' tags: - Streams parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingBatch' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingBatch' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/requests: get: operationId: streams_pricing_request_list_listPricingTransformationRequests description: '' tags: - Streams parameters: - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: assignee.id description: 'Filter for: assignee.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: batch.context.pricelist_version.id description: 'Filter for: batch.context.pricelist_version.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: batch.context.pricelist_version.start_at description: 'Filter for: batch.context.pricelist_version.start_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: batch.context.pricelist_version.status description: 'Filter for: batch.context.pricelist_version.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: batch.id description: 'Filter for: batch.id **lookups:** eq, ne, like, ilike, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: batch.name description: 'Filter for: batch.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: events description: 'Filter for: events **lookups:** eq, ne, like, ilike, in, out **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.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: stats description: 'Filter for: stats **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, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - scheduled - pending - completed - published - failed - canceled - name: stream.context.account.id description: 'Filter for: stream.context.account.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.account.name description: 'Filter for: stream.context.account.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.listing.id description: 'Filter for: stream.context.listing.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.id description: 'Filter for: stream.context.marketplace.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.marketplace.name description: 'Filter for: stream.context.marketplace.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.pricelist.id description: 'Filter for: stream.context.pricelist.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.id description: 'Filter for: stream.context.product.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.context.product.name description: 'Filter for: stream.context.product.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.id description: 'Filter for: stream.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: stream.name description: 'Filter for: stream.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: stream.owner.id description: 'Filter for: stream.owner.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: transformation.columns description: 'Filter for: transformation.columns **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: transformation.description description: 'Filter for: transformation.description **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: transformation.function.id description: 'Filter for: transformation.function.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: transformation.function.manual description: 'Filter for: transformation.function.manual **lookups:** eq, ne, null' in: query required: false deprecated: false schema: type: boolean - name: transformation.position description: 'Filter for: transformation.position **lookups:** eq, ne, ge, gt, le, lt, null, in, out **ordering:** true' in: query required: false deprecated: false schema: type: integer - name: validation.status description: 'Filter for: validation.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - pending - processing - success - failed responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.PricingTransformationRequest' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' /pricing/requests/{pk}: get: operationId: streams_pricing_request_detail_retrievePricingTransformationRequest description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingTransformationRequest' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_pricing_request_detail_updateTransformationRequestUpdate description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequestUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequestUpdate' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/requests/{pk}/fail: post: operationId: streams_pricing_request_fail_postFailTransformationRequestFail description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequestFail' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.TransformationRequest' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/requests/{pk}/process: post: operationId: streams_pricing_request_process_postProcessPricingTransformationRequest description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingTransformationRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingTransformationRequest' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams: get: operationId: streams_pricing_stream_list_listPricingStreams description: '' tags: - Streams parameters: - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: context description: 'Filter for: context **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: context.account.id description: 'Filter for: context.account.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.account.name description: 'Filter for: context.account.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: context.listing.id description: 'Filter for: context.listing.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.marketplace.id description: 'Filter for: context.marketplace.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.marketplace.name description: 'Filter for: context.marketplace.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: context.pricelist.id description: 'Filter for: context.pricelist.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.product.id description: 'Filter for: context.product.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: context.product.name description: 'Filter for: context.product.name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: events description: 'Filter for: events **lookups:** eq, ne, like, ilike, in, out **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 **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' in: query required: false deprecated: false schema: type: string - name: samples description: 'Filter for: samples **lookups:** eq, ne, like, ilike, in, out **default:** *hidden*' in: query required: false deprecated: false schema: type: string - name: sources.id description: 'Filter for: sources.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: sources.samples description: 'Filter for: sources.samples **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, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - configuring - active - terminated - deleted - name: validation.status description: 'Filter for: validation.status **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - draft - processing - published - failed - deleted - name: visibility description: 'Filter for: visibility **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - private - published responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.PricingStream' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' post: operationId: streams_pricing_stream_list_createPricingStreamWrite description: '' tags: - Streams parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingStreamWrite' responses: '201': content: application/json: schema: $ref: '#/components/schemas/streams.PricingStreamWrite' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams/{pk}: get: operationId: streams_pricing_stream_detail_retrievePricingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_pricing_stream_detail_updatePricingStreamWrite description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingStreamWrite' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingStreamWrite' description: '' '400': $ref: '#/components/responses/streams.any_400' delete: operationId: streams_pricing_stream_detail_destroyPricingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string responses: '204': description: '' /pricing/streams/{pk}/activate: post: operationId: streams_pricing_stream_activate_postActivatePricingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams/{pk}/configure: post: operationId: streams_pricing_stream_configure_postConfigurePricingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams/{pk}/terminate: post: operationId: streams_pricing_stream_terminate_postTerminatePricingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams/{pk}/validate: post: operationId: streams_pricing_stream_validate_postValidatePricingStream description: '' tags: - Streams parameters: - name: pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.PricingStream' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams/{stream_pk}/columns: get: operationId: streams_pricing_columns_list_listColumns description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: name description: 'Filter for: name **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string - name: origin.id description: 'Filter for: origin.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: origin.position description: 'Filter for: origin.position **lookups:** eq, ne, ge, gt, le, lt, null, in, out' in: query required: false deprecated: false schema: type: integer - name: output description: 'Filter for: output **lookups:** eq, ne' in: query required: false deprecated: false schema: type: boolean responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/streams.Column' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams/{stream_pk}/columns/{verbose_id}: get: operationId: streams_pricing_columns_detail_retrieveColumn description: '' tags: - Streams parameters: - name: stream_pk 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/streams.Column' description: '' '400': $ref: '#/components/responses/streams.any_400' put: operationId: streams_pricing_columns_detail_updateColumnUpdate description: '' tags: - Streams parameters: - name: stream_pk 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/streams.ColumnUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/streams.ColumnUpdate' description: '' '400': $ref: '#/components/responses/streams.any_400' /pricing/streams/{stream_pk}/transformations: get: operationId: streams_pricing_transformations_list_listTransformations description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/streams.RQLContentRangeLimitOffsetPagination.offset' - name: columns description: "Filter for: columns\n\n**lookups:** \n\n**default:** *hidden*" in: query required: false deprecated: false schema: type: string - name: function.manual description: 'Filter for: function.manual **lookups:** eq, ne, null **default:** *hidden*' in: query required: false deprecated: false schema: type: boolean responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object post: operationId: streams_pricing_transformations_list_createTransformationWrite description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: type: object properties: function: type: object properties: id: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean settings: type: object gravity: type: object responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 201: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object /pricing/streams/{stream_pk}/transformations/{verbose_id}: get: operationId: streams_pricing_transformations_detail_retrieveTransformation description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - name: verbose_id in: path required: true description: '' schema: type: string responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object put: operationId: streams_pricing_transformations_detail_updateTransformationWrite description: '' tags: - Streams parameters: - name: stream_pk 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: function: type: object properties: id: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean settings: type: object gravity: type: object responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object delete: operationId: streams_pricing_transformations_detail_destroyTransformation description: '' tags: - Streams parameters: - name: stream_pk in: path required: true description: '' schema: type: string - name: verbose_id in: path required: true description: '' schema: type: string responses: 400: description: '' content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string 200: description: '' content: application/json: schema: type: object properties: id: type: string function: type: object properties: id: type: string name: type: string status: type: string overview: type: string columns: type: object properties: input: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean output: type: array items: type: object properties: id: type: string name: type: string type: type: string description: type: string output: type: boolean constraints: type: object required: type: boolean position: type: integer settings: type: object /embed/leads/listings/{listing_id}/form: get: operationId: embed_listing_form_detail_retrieveListingLeadFormEmbed description: Retrieve the listing **Lead Form** using Listing JWT authentication for embedding. tags: - Embedded Listings parameters: - name: listing_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: default: $ref: '#/components/examples/ListingLeadsFormResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /embed/leads/listings/{listing_id}/leads: post: operationId: embed_listing_leads_list_createLeadEmbed description: Create a new **Lead** using Listing JWT authentication for embedding. tags: - Embedded Listings parameters: - name: listing_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/ListingLeadsCreateExample' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/ListingLeadsCreateResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/forms: get: operationId: forms_list_listLeadFormReads description: List the **Lead Forms**. tags: - Leads parameters: - $ref: '#/components/parameters/RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/RQLContentRangeLimitOffsetPagination.offset' - 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' in: query required: false deprecated: false schema: type: string - name: schema description: "This filter parameter can be used as `select(schema)` to include\ \ the schema the response.\n\n**lookups:** \n\n**default:** *hidden*" in: query required: false deprecated: false schema: type: string - name: status description: 'Filter for: status **lookups:** eq, ne, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - active - inactive - name: template description: 'Filter for: template **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - aws - azure - commerce - custom - default - gcp responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/LeadFormRead' examples: default: $ref: '#/components/examples/LeadsFormDetailedResponseExample-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/any_400' post: operationId: forms_list_createLeadForm description: Create a new **Lead Form**. Only Vendors can create new Lead Forms. tags: - Leads parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: custom_template: $ref: '#/components/examples/LeadsFormCreateExample-custom_template' default_template: $ref: '#/components/examples/LeadsFormCreateExample-default_template' responses: '201': content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: default: $ref: '#/components/examples/LeadsFormResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/forms/{id}: get: operationId: forms_detail_retrieveLeadFormRead description: Retrieve the details of a **Lead Form**. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadFormRead' examples: default: $ref: '#/components/examples/LeadsFormDetailedResponseExample' description: '' '400': $ref: '#/components/responses/any_400' put: operationId: forms_detail_updateLeadForm description: Update an existing **Lead Form**. Only the Vendor owner of the Form can update it. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: default: $ref: '#/components/examples/LeadsFormUpdateExample' responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: default: $ref: '#/components/examples/LeadsFormResponseExample' description: '' '400': $ref: '#/components/responses/any_400' delete: operationId: forms_detail_destroyLeadForm description: Delete a **Lead Form**. Only the Vendor owner of the Form can delete it. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /leads/forms/{id}/activate: post: operationId: forms_activate_postActivateLeadFormRead description: Activate a **Lead Form**. Only the Vendor owner of the Form can activate it. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadFormRead' examples: default: $ref: '#/components/examples/LeadsFormDetailedResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/forms/{id}/deactivate: post: operationId: forms_deactivate_postDeactivateLeadFormRead description: Deactivate a **Lead Form**. Only the Vendor owner of the Form can deactivate it. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadFormRead' examples: default: $ref: '#/components/examples/LeadsFormDetailedResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/listings/{listing_id}/form: get: operationId: listing_form_detail_retrieveListingLeadForm description: Retrieve the listing **Lead Form**. tags: - Listings parameters: - name: listing_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: default: $ref: '#/components/examples/LeadsFormResponseExample' description: '' '400': $ref: '#/components/responses/any_400' put: operationId: listing_form_detail_updateListingLeadForm description: Set the listing **Lead Form**. tags: - Listings parameters: - name: listing_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: default: $ref: '#/components/examples/ListingFormUpdateExample' responses: '200': content: application/json: schema: $ref: '#/components/schemas/LeadForm' examples: default: $ref: '#/components/examples/LeadsFormResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/records: get: operationId: leads_list_listLeads description: List the **Leads** visible by the current account. tags: - Leads parameters: - $ref: '#/components/parameters/RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/RQLContentRangeLimitOffsetPagination.offset' - name: distributor.id description: 'Filter for: distributor.id **lookups:** eq, ne, like, ilike, null, in, out' in: query required: false deprecated: false schema: type: string - name: distributor.name description: 'Filter for: distributor.name **lookups:** eq, ne, like, ilike, 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: 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' 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' in: query required: false deprecated: false schema: type: string - name: status description: 'Filter for: status **lookups:** eq, ne, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string enum: - pending - invalid - qualified responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsResponseExample-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/any_400' post: operationId: leads_list_createLead description: Create a new **Lead**. Only Distributors can create new Leads. tags: - Leads parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsCreateExample' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/records/{id}: get: operationId: leads_detail_retrieveLeadWithData description: Retrieve the details of a **Lead**, including the Lead Data. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string - name: data description: 'This filter parameter can be used as `select(-data)` to exclude the raw data in the response. **lookups:** ' in: query required: false deprecated: false schema: type: string - name: data_formatted description: "This filter parameter can be used as `select(data_formatted)`\ \ to include the human friendly formatted data in the response.\n\n**lookups:**\ \ \n\n**default:** *hidden*" in: query required: false deprecated: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsDetailedResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/records/{id}/invalidate: post: operationId: leads_invalidate_postInvalidateLead description: Invalidate a **Lead**. Only the Vendor can invalidate it. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsInvalidateExample' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsDetailedResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /leads/records/{id}/qualify: post: operationId: leads_qualify_postQualifyLead description: Qualify a **Lead**. Only the Vendor can qualify it. tags: - Leads parameters: - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsQualifyExample' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Lead' examples: default: $ref: '#/components/examples/LeadsDetailedResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /modules/MD-0032/settings: get: operationId: modules_MD_0032_settings_retrieveLeadsModuleSettingsViewSet description: Get key pair info for the current Account. tags: - General Collections parameters: [] responses: '200': content: application/json: schema: {} examples: default: $ref: '#/components/examples/ModuleSettingsResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /modules/leads/settings: get: operationId: modules_leads_settings_retrieveLeadsModuleSettingsViewSet description: Get key pair info for the current Account. tags: - General Collections parameters: [] responses: '200': content: application/json: schema: {} examples: default: $ref: '#/components/examples/ModuleSettingsResponseExample' description: '' '400': $ref: '#/components/responses/any_400' /custom/objects/{entity_id}/attributes: get: operationId: custom_custom_attribute_detail_listCustomAttributes description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/custom.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/custom.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 - name: owner.id description: 'Filter for: owner.id **lookups:** eq, in' in: query required: false deprecated: false schema: type: string - name: owner.name description: 'Filter for: owner.name **lookups:** eq, in **ordering:** true' in: query required: false deprecated: false schema: type: string responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/custom.CustomAttribute' examples: default: $ref: '#/components/examples/custom.CustomAttributeListResponseExample-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/custom.any_400' put: operationId: custom_custom_attribute_detail_updateCustomAttributeUpsert description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/custom.CustomAttribute' examples: default: $ref: '#/components/examples/custom.UpsertCustomAttributeRequestExample' responses: '200': content: application/json: schema: $ref: '#/components/schemas/custom.CustomAttribute' examples: default: $ref: '#/components/examples/custom.CustomAttributeDetailedResponseExample' description: '' '400': $ref: '#/components/responses/custom.any_400' /custom/objects/{entity_id}/attributes-history: get: operationId: custom_custom_attribute_history_list_listCustomAttributeHistories description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/custom.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/custom.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/custom.CustomAttributeHistory' examples: default: $ref: '#/components/examples/custom.CustomAttributeHistoryListResponseExample-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/custom.any_400' /custom/objects/{entity_id}/attributes/metadata: get: operationId: custom_custom_attribute_meta_retrieveCustomAttributeMetadataUpsert description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/custom.CustomAttribute' examples: default: $ref: '#/components/examples/custom.MetadataCaResponseExample' description: '' '400': $ref: '#/components/responses/custom.any_400' put: operationId: custom_custom_attribute_meta_updateCustomAttributeMetadataUpsert description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/custom.CustomAttribute' examples: default: $ref: '#/components/examples/custom.MetadataCaUpdateRequestExample' responses: '200': content: application/json: schema: $ref: '#/components/schemas/custom.CustomAttribute' examples: default: $ref: '#/components/examples/custom.MetadataCaResponseExample' description: '' '400': $ref: '#/components/responses/custom.any_400' /custom/objects/{entity_id}/prototypes: get: operationId: custom_custom_prototypes_list_listAttributePrototypes description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/custom.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/custom.RQLContentRangeLimitOffsetPagination.offset' - name: attribute.id description: 'Filter for: attribute.id **lookups:** eq, ne, like, ilike, in, out **ordering:** true' in: query required: false deprecated: false schema: type: string - name: attribute.type description: 'Filter for: attribute.type **lookups:** eq, ne, like, ilike, in, out' in: query required: false deprecated: false schema: type: string enum: - text - dropdown - 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 - name: id description: 'Filter for: 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/custom.AttributePrototype' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/custom.any_400' post: operationId: custom_custom_prototypes_list_createAttributePrototypeCreate description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/custom.AttributePrototypeCreate' responses: '201': content: application/json: schema: $ref: '#/components/schemas/custom.AttributePrototypeCreate' description: '' '400': $ref: '#/components/responses/custom.any_400' /custom/objects/{entity_id}/prototypes/{id}: get: operationId: custom_custom_prototypes_detail_retrieveAttributePrototype description: '' tags: - Custom Attributes parameters: - name: entity_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: $ref: '#/components/schemas/custom.AttributePrototype' description: '' '400': $ref: '#/components/responses/custom.any_400' put: operationId: custom_custom_prototypes_detail_updateAttributePrototypeUpdate description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/custom.AttributePrototypeUpdate' responses: '200': content: application/json: schema: $ref: '#/components/schemas/custom.AttributePrototypeUpdate' description: '' '400': $ref: '#/components/responses/custom.any_400' delete: operationId: custom_custom_prototypes_detail_destroyAttributePrototype description: '' tags: - Custom Attributes parameters: - name: entity_id in: path required: true description: '' schema: type: string - name: id in: path required: true description: '' schema: type: string responses: '204': description: '' /custom/objects/{parent_id}/items/-/attributes: get: operationId: custom_custom_attribute_subscription_items_list_listCustomAttributeExtendeds description: '' tags: - Custom Attributes parameters: - name: parent_id in: path required: true description: '' schema: type: string - $ref: '#/components/parameters/custom.RQLContentRangeLimitOffsetPagination.limit' - $ref: '#/components/parameters/custom.RQLContentRangeLimitOffsetPagination.offset' responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/custom.CustomAttribute' examples: default: $ref: '#/components/examples/custom.CustomAttributeItemsListResponseExample-list' description: '' headers: Content-Range: $ref: '#/components/headers/Content-Range' '400': $ref: '#/components/responses/custom.any_400' components: schemas: Account: properties: id: type: string maxLength: 16 name: type: string maxLength: 64 icon: type: string nullable: true maxLength: 2000 type: object required: - id - name Lead: properties: id: type: string readOnly: true listing: $ref: '#/components/schemas/Listing' writeOnly: true name: type: string writeOnly: true data: type: object writeOnly: true type: object required: - listing - name - data LeadForm: properties: id: type: string readOnly: true schema: type: object readOnly: true listing_id: type: string writeOnly: true type: object required: - listing_id LeadFormRead: properties: id: type: string readOnly: true name: type: string maxLength: 128 owner: $ref: '#/components/schemas/Account' status: type: string readOnly: true template: type: string schema: type: object events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string deleted: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true listings: type: array items: type: string type: object required: - name - template - schema LeadFormReference: properties: id: type: string readOnly: true name: type: string maxLength: 128 owner: $ref: '#/components/schemas/Account' status: type: string enum: - active - inactive template: type: string enum: - aws - azure - commerce - custom - default - gcp type: object required: - name - owner - template Listing: properties: id: type: string product: $ref: '#/components/schemas/Product' marketplace: $ref: '#/components/schemas/Marketplace' provider: $ref: '#/components/schemas/Account' type: object required: - id Marketplace: properties: id: type: string maxLength: 16 name: type: string maxLength: 255 icon: type: string nullable: true maxLength: 2000 type: object required: - id - name Product: properties: id: type: string maxLength: 100 name: type: string maxLength: 255 icon: type: string nullable: true maxLength: 2000 type: object required: - id - name auth.ACLRule: properties: id: type: string readOnly: true action: type: string readOnly: true value: type: string maxLength: 512 comment: type: string nullable: true maxLength: 1024 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - value auth.ACLSettings: properties: domain: type: string enum: - allow - deny nullable: true ips: type: array items: $ref: '#/components/schemas/auth.IPAddressRanges' type: object required: - domain auth.Account: properties: id: type: string readOnly: true name: type: string maxLength: 64 icon: type: string format: binary nullable: true description: type: string nullable: true maxLength: 512 overview: type: string nullable: true headquarters: type: string nullable: true maxLength: 256 type: type: string enum: - vendor - provider role: type: string enum: - vendor - distributor - reseller brand: type: string maxLength: 100 external_id: type: string maxLength: 100 sourcing: type: boolean description: This flag enables sourcing to other providers through catalog countries: type: array items: {} nullable: true description: 'Template (ISO 3166 Alpha 2: List of codes):
[
"GB",
"RU"
]' languages: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] websites: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] industries: type: array items: $ref: '#/components/schemas/auth.Industry' public: type: boolean nullable: true description: Flag to show Account data in public CB catalog. events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true permissions: type: object readOnly: true type: object required: - name auth.AccountCreate: properties: id: type: string maxLength: 100 name: type: string maxLength: 64 icon: type: string format: binary nullable: true description: type: string nullable: true maxLength: 512 overview: type: string nullable: true headquarters: type: string nullable: true maxLength: 256 external_id: type: string maxLength: 100 countries: type: array items: {} nullable: true description: 'Template (ISO 3166 Alpha 2: List of codes):
[
"GB",
"RU"
]' languages: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] websites: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] industries: type: array items: $ref: '#/components/schemas/auth.IdWrite' users: type: array items: $ref: '#/components/schemas/auth.IdWrite' permissions: $ref: '#/components/schemas/auth._AccountPermissionsWrite' type: object required: - name auth.AccountReference: properties: id: type: string readOnly: true name: type: string maxLength: 64 icon: type: string format: binary nullable: true type: object required: - name auth.AccountSettings: properties: acl: $ref: '#/components/schemas/auth.ACLSettings' domain: type: string readOnly: true data: type: string readOnly: true mfa: $ref: '#/components/schemas/auth.MFASettings' type: object required: - acl auth.AccountUpdate: properties: id: type: string maxLength: 100 name: type: string maxLength: 64 icon: type: string format: binary nullable: true description: type: string nullable: true maxLength: 512 overview: type: string nullable: true headquarters: type: string nullable: true maxLength: 256 external_id: type: string maxLength: 100 countries: type: array items: {} nullable: true description: 'Template (ISO 3166 Alpha 2: List of codes):
[
"GB",
"RU"
]' languages: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] websites: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] industries: type: array items: $ref: '#/components/schemas/auth.IdWrite' users: type: array items: $ref: '#/components/schemas/auth.IdWrite' permissions: $ref: '#/components/schemas/auth._AccountPermissionsWrite' brand: type: string maxLength: 100 type: object auth.AccountUserCreate: properties: id: type: string name: type: string email: type: string format: email groups: type: array items: $ref: '#/components/schemas/auth.IdWrite' minItems: 1 tags: type: array items: $ref: '#/components/schemas/auth.IdWrite' type: object required: - groups auth.AccountUserUpdate: properties: groups: type: array items: $ref: '#/components/schemas/auth.IdWrite' tags: type: array items: $ref: '#/components/schemas/auth.IdWrite' idp: $ref: '#/components/schemas/auth.IdWrite' type: object auth.DomainAccount: properties: id: type: string readOnly: true name: type: string readOnly: true description: type: string readOnly: true domain: type: string readOnly: true token: type: string readOnly: true auth: $ref: '#/components/schemas/auth.DomainAuthRead' readOnly: true status: type: string enum: - pending - rejected - verified - failed - deleted readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string pended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string rejected: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string reason: type: string verified: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string failed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string reason: type: string readOnly: true type: object auth.DomainAuthRead: properties: idp: $ref: '#/components/schemas/auth.IDPReference' enforce: type: boolean type: object required: - idp - enforce auth.DomainAuthWrite: properties: idp: $ref: '#/components/schemas/auth.IdWrite' enforce: type: boolean type: object auth.DomainCreate: properties: domain: type: string maxLength: 256 type: object required: - domain auth.DomainUpdate: properties: name: type: string nullable: true maxLength: 128 description: type: string nullable: true maxLength: 512 auth: $ref: '#/components/schemas/auth.DomainAuthWrite' type: object auth.DomainUser: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 128 auth: $ref: '#/components/schemas/auth.DomainAuthRead' readOnly: true type: object auth.DomainUserUpdate: properties: idp: $ref: '#/components/schemas/auth.IdWrite' type: object auth.Extension: properties: id: type: string readOnly: true name: type: string description: 'Extension type (f.e. "zapier"): should be lowercase, without whitespace.' maxLength: 50 icon: type: string format: binary nullable: true revision: type: integer readOnly: true external_id: type: string nullable: true maxLength: 256 subtitle: type: string nullable: true maxLength: 128 description: type: string description: Extension type description (f.e. "Zapier Integration") maxLength: 255 overview: type: string nullable: true portal: type: string enum: - any - provider - vendor description: Extension applicability in Connect scope featured: type: boolean priority: type: integer maximum: 2147483647 minimum: -2147483648 status: type: string enum: - draft - published - unrestricted - publishing - unpublishing description: Unrestricted - already developed public extension (f.e. Zapier) websites: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] categories: type: array items: $ref: '#/components/schemas/auth.ExtensionCategory' industries: type: array items: $ref: '#/components/schemas/auth.Industry' owner: $ref: '#/components/schemas/auth.AccountReference' constraints: type: object properties: account: type: object properties: tokens: type: integer readOnly: true system: type: boolean events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - name - description auth.ExtensionCategory: properties: id: type: string readOnly: true name: type: string maxLength: 255 type: object required: - name auth.ExtensionCreate: properties: id: type: string readOnly: true name: type: string description: 'Extension type (f.e. "zapier"): should be lowercase, without whitespace.' maxLength: 50 icon: type: string format: binary nullable: true revision: type: integer readOnly: true external_id: type: string nullable: true maxLength: 256 subtitle: type: string nullable: true maxLength: 128 description: type: string description: Extension type description (f.e. "Zapier Integration") maxLength: 255 overview: type: string nullable: true portal: type: string enum: - any - provider - vendor description: Extension applicability in Connect scope featured: type: boolean priority: type: integer maximum: 2147483647 minimum: -2147483648 status: type: string enum: - draft - published - unrestricted - publishing - unpublishing description: Unrestricted - already developed public extension (f.e. Zapier) websites: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] categories: type: array items: $ref: '#/components/schemas/auth.IdWrite' industries: type: array items: $ref: '#/components/schemas/auth.IdWrite' owner: $ref: '#/components/schemas/auth.AccountReference' constraints: $ref: '#/components/schemas/auth._ExtensionConstraints' system: type: boolean events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - name - description auth.ExtensionReference: properties: id: type: string readOnly: true name: type: string description: 'Extension type (f.e. "zapier"): should be lowercase, without whitespace.' maxLength: 50 icon: type: string format: binary nullable: true revision: type: integer readOnly: true type: object required: - name auth.ExtensionUpdate: properties: id: type: string readOnly: true name: type: string description: 'Extension type (f.e. "zapier"): should be lowercase, without whitespace.' maxLength: 50 icon: type: string format: binary nullable: true revision: type: integer readOnly: true external_id: type: string nullable: true maxLength: 256 subtitle: type: string nullable: true maxLength: 128 description: type: string description: Extension type description (f.e. "Zapier Integration") maxLength: 255 overview: type: string nullable: true portal: type: string enum: - any - provider - vendor description: Extension applicability in Connect scope featured: type: boolean priority: type: integer maximum: 2147483647 minimum: -2147483648 status: type: string enum: - draft - published - unrestricted - publishing - unpublishing description: Unrestricted - already developed public extension (f.e. Zapier) websites: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] categories: type: array items: $ref: '#/components/schemas/auth.IdWrite' industries: type: array items: $ref: '#/components/schemas/auth.IdWrite' owner: $ref: '#/components/schemas/auth.AccountReference' constraints: $ref: '#/components/schemas/auth._ExtensionConstraints' system: type: boolean events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object auth.Group: properties: id: type: string name: type: string maxLength: 32 description: type: string maxLength: 512 color: type: string nullable: true maxLength: 32 external_id: type: string nullable: true maxLength: 64 revision: type: integer events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string decommissioned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true permissions: 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 stats: $ref: '#/components/schemas/auth.GroupStats' readOnly: true type: object required: - id - name - description - revision - permissions auth.GroupBase: properties: id: type: string name: type: string maxLength: 32 description: type: string maxLength: 512 color: type: string nullable: true maxLength: 32 external_id: type: string nullable: true maxLength: 64 revision: type: integer type: object required: - id - name - description - revision auth.GroupCreate: properties: name: type: string maxLength: 32 description: type: string maxLength: 512 color: type: string nullable: true maxLength: 32 external_id: type: string nullable: true maxLength: 64 type: object required: - name - description auth.GroupStats: properties: users: type: integer type: object required: - users auth.GroupUpdate: properties: name: type: string maxLength: 32 description: type: string maxLength: 512 color: type: string maxLength: 32 external_id: type: string nullable: true maxLength: 64 type: object auth.GroupUserChangeMembership: properties: id: type: string type: object required: - id auth.IDPAccount: properties: id: type: string readOnly: true name: type: string readOnly: true description: type: string readOnly: true external_id: type: string readOnly: true type: type: string readOnly: true settings: $ref: '#/components/schemas/auth._IDPSettings' readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object auth.IDPCreate: properties: name: type: string nullable: true maxLength: 128 external_id: type: string nullable: true maxLength: 128 description: type: string nullable: true maxLength: 512 type: type: string enum: - system - saml - openid settings: $ref: '#/components/schemas/auth._IDPSettings' type: object required: - type auth.IDPReference: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 128 type: type: string enum: - system - saml - openid type: object required: - type auth.IDPUpdate: properties: name: type: string nullable: true maxLength: 128 external_id: type: string nullable: true maxLength: 128 description: type: string nullable: true maxLength: 512 settings: $ref: '#/components/schemas/auth._IDPSettings' type: object auth.IPAddressRanges: properties: name: type: string ip_range: type: array items: type: string maxItems: 2 type: object required: - name - ip_range auth.IdWrite: properties: id: type: string writeOnly: true type: object required: - id auth.Industry: properties: id: type: string readOnly: true name: type: string maxLength: 255 type: object required: - name auth.MFASettings: properties: policy: type: string enum: - optional - suggested - required type: object required: - policy auth.Module: properties: id: type: string readOnly: true name: type: string maxLength: 32 type: object required: - name auth.PasswordChange: properties: old_password: type: string writeOnly: true maxLength: 64 password: type: string writeOnly: true maxLength: 64 type: object required: - old_password - password auth.PermissionMerge: properties: id: type: string object: $ref: '#/components/schemas/auth.PermissionObjectMerge' type: object auth.PermissionObjectMerge: properties: id: type: string type: object required: - id auth.Phone: properties: country_code: type: string maxLength: 4 area_code: type: string nullable: true maxLength: 4 phone_number: type: string maxLength: 20 type: object required: - country_code - phone_number auth.SerializerCls: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 50 position: type: integer maximum: 8 minimum: 1 type: type: string enum: - image - video thumbnail: type: string format: binary url: type: string format: uri nullable: true maxLength: 500 description: type: string nullable: true maxLength: 255 type: object required: - position - thumbnail auth.Tag: properties: id: type: string readOnly: true name: type: string maxLength: 32 type: object required: - name auth.Token: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 128 description: type: string nullable: true maxLength: 255 external_id: type: string nullable: true maxLength: 128 owner: $ref: '#/components/schemas/auth.AccountReference' status: type: string enum: - pending - active - inactive - deleted - expiring - expired - revitalised extension: $ref: '#/components/schemas/auth.ExtensionReference' handle: type: string readOnly: true token: type: string readOnly: true events: type: object properties: {} readOnly: true permissions: 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 expiration_date: type: string format: date-time nullable: true renewed_expiration_date: type: string format: date-time nullable: true renewed_token: type: string readOnly: true type: object required: - owner - extension - permissions auth.TokenRenewRotate: properties: expiration_date: type: string format: date-time nullable: true type: object auth.TokenUpdate: properties: name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 128 description: type: string maxLength: 255 type: object auth.TokenWrite: properties: name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 128 extension: $ref: '#/components/schemas/auth._ExtensionWrite' description: type: string nullable: true maxLength: 255 owner: $ref: '#/components/schemas/auth.IdWrite' expiration_date: type: string format: date-time nullable: true type: object required: - name - extension auth.User: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 128 icon: type: string format: binary nullable: true active: type: string readOnly: true blocklisted: type: boolean description: Email notifications to the user disabled because of bounces. Unsetting this won't unblock the user, please remove the email address from Notifications Backoffice -> Blocklist instead. email: type: string format: email maxLength: 254 notifications: type: string readOnly: true description: Just for backward compatibility announcements: type: boolean description: Receive marketing news and announcements region: type: string enum: - aa - aa_DJ - aa_ER - aa_ET - ab - ab_GE - af - af_NA - af_ZA - agq - agq_CM - ak - ak_GH - am - am_ET - an - an_ES - ann - ann_NG - apc - apc_SY - ar - ar_001 - ar_AE - ar_BH - ar_DJ - ar_DZ - ar_EG - ar_EH - ar_ER - ar_IL - ar_IQ - ar_JO - ar_KM - ar_KW - ar_LB - ar_LY - ar_MA - ar_MR - ar_OM - ar_PS - ar_QA - ar_SA - ar_SD - ar_SO - ar_SS - ar_SY - ar_TD - ar_TN - ar_YE - arn - arn_CL - as - as_IN - asa - asa_TZ - ast - ast_ES - az - az_Arab - az_Arab_IQ - az_Arab_IR - az_Arab_TR - az_Cyrl - az_Cyrl_AZ - az_Latn - az_Latn_AZ - ba - ba_RU - bal - bal_Arab - bal_Arab_PK - bal_Latn - bal_Latn_PK - bas - bas_CM - be - be_BY - be_TARASK - bem - bem_ZM - bew - bew_ID - bez - bez_TZ - bg - bg_BG - bgc - bgc_IN - bgn - bgn_AE - bgn_AF - bgn_IR - bgn_OM - bgn_PK - bho - bho_IN - blo - blo_BJ - blt - blt_VN - bm - bm_ML - bm_Nkoo - bm_Nkoo_ML - bn - bn_BD - bn_IN - bo - bo_CN - bo_IN - br - br_FR - brx - brx_IN - bs - bs_Cyrl - bs_Cyrl_BA - bs_Latn - bs_Latn_BA - bss - bss_CM - byn - byn_ER - ca - ca_AD - ca_ES - ca_ES_VALENCIA - ca_FR - ca_IT - cad - cad_US - cch - cch_NG - ccp - ccp_BD - ccp_IN - ce - ce_RU - ceb - ceb_PH - cgg - cgg_UG - cho - cho_US - chr - chr_US - cic - cic_US - ckb - ckb_IQ - ckb_IR - co - co_FR - cs - cs_CZ - csw - csw_CA - cu - cu_RU - cv - cv_RU - cy - cy_GB - da - da_DK - da_GL - dav - dav_KE - de - de_AT - de_BE - de_CH - de_DE - de_IT - de_LI - de_LU - dje - dje_NE - doi - doi_IN - dsb - dsb_DE - dua - dua_CM - dv - dv_MV - dyo - dyo_SN - dz - dz_BT - ebu - ebu_KE - ee - ee_GH - ee_TG - el - el_CY - el_GR - el_POLYTON - en - en_001 - en_150 - en_AE - en_AG - en_AI - en_AS - en_AT - en_AU - en_BB - en_BE - en_BI - en_BM - en_BS - en_BW - en_BZ - en_CA - en_CC - en_CH - en_CK - en_CM - en_CX - en_CY - en_DE - en_DG - en_DK - en_DM - en_Dsrt - en_Dsrt_US - en_ER - en_FI - en_FJ - en_FK - en_FM - en_GB - en_GD - en_GG - en_GH - en_GI - en_GM - en_GU - en_GY - en_HK - en_ID - en_IE - en_IL - en_IM - en_IN - en_IO - en_JE - en_JM - en_KE - en_KI - en_KN - en_KY - en_LC - en_LR - en_LS - en_MG - en_MH - en_MO - en_MP - en_MS - en_MT - en_MU - en_MV - en_MW - en_MY - en_NA - en_NF - en_NG - en_NL - en_NR - en_NU - en_NZ - en_PG - en_PH - en_PK - en_PN - en_PR - en_PW - en_RW - en_SB - en_SC - en_SD - en_SE - en_SG - en_SH - en_SI - en_SL - en_SS - en_SX - en_SZ - en_Shaw - en_Shaw_GB - en_TC - en_TK - en_TO - en_TT - en_TV - en_TZ - en_UG - en_UM - en_US - en_US_POSIX - en_VC - en_VG - en_VI - en_VU - en_WS - en_ZA - en_ZM - en_ZW - eo - eo_001 - es - es_419 - es_AR - es_BO - es_BR - es_BZ - es_CL - es_CO - es_CR - es_CU - es_DO - es_EA - es_EC - es_ES - es_GQ - es_GT - es_HN - es_IC - es_MX - es_NI - es_PA - es_PE - es_PH - es_PR - es_PY - es_SV - es_US - es_UY - es_VE - et - et_EE - eu - eu_ES - ewo - ewo_CM - fa - fa_AF - fa_IR - ff - ff_Adlm - ff_Adlm_BF - ff_Adlm_CM - ff_Adlm_GH - ff_Adlm_GM - ff_Adlm_GN - ff_Adlm_GW - ff_Adlm_LR - ff_Adlm_MR - ff_Adlm_NE - ff_Adlm_NG - ff_Adlm_SL - ff_Adlm_SN - ff_Latn - ff_Latn_BF - ff_Latn_CM - ff_Latn_GH - ff_Latn_GM - ff_Latn_GN - ff_Latn_GW - ff_Latn_LR - ff_Latn_MR - ff_Latn_NE - ff_Latn_NG - ff_Latn_SL - ff_Latn_SN - fi - fi_FI - fil - fil_PH - fo - fo_DK - fo_FO - fr - fr_BE - fr_BF - fr_BI - fr_BJ - fr_BL - fr_CA - fr_CD - fr_CF - fr_CG - fr_CH - fr_CI - fr_CM - fr_DJ - fr_DZ - fr_FR - fr_GA - fr_GF - fr_GN - fr_GP - fr_GQ - fr_HT - fr_KM - fr_LU - fr_MA - fr_MC - fr_MF - fr_MG - fr_ML - fr_MQ - fr_MR - fr_MU - fr_NC - fr_NE - fr_PF - fr_PM - fr_RE - fr_RW - fr_SC - fr_SN - fr_SY - fr_TD - fr_TG - fr_TN - fr_VU - fr_WF - fr_YT - frr - frr_DE - fur - fur_IT - fy - fy_NL - ga - ga_GB - ga_IE - gaa - gaa_GH - gd - gd_GB - gez - gez_ER - gez_ET - gl - gl_ES - gn - gn_PY - gsw - gsw_CH - gsw_FR - gsw_LI - gu - gu_IN - guz - guz_KE - gv - gv_IM - ha - ha_Arab - ha_Arab_NG - ha_Arab_SD - ha_GH - ha_NE - ha_NG - haw - haw_US - he - he_IL - hi - hi_IN - hi_Latn - hi_Latn_IN - hnj - hnj_Hmnp - hnj_Hmnp_US - hr - hr_BA - hr_HR - hsb - hsb_DE - hu - hu_HU - hy - hy_AM - ia - ia_001 - id - id_ID - ie - ie_EE - ig - ig_NG - ii - ii_CN - io - io_001 - is - is_IS - it - it_CH - it_IT - it_SM - it_VA - iu - iu_CA - iu_Latn - iu_Latn_CA - ja - ja_JP - jbo - jbo_001 - jgo - jgo_CM - jmc - jmc_TZ - jv - jv_ID - ka - ka_GE - kaa - kaa_Cyrl - kaa_Cyrl_UZ - kaa_Latn - kaa_Latn_UZ - kab - kab_DZ - kaj - kaj_NG - kam - kam_KE - kcg - kcg_NG - kde - kde_TZ - kea - kea_CV - ken - ken_CM - kgp - kgp_BR - khq - khq_ML - ki - ki_KE - kk - kk_Arab - kk_Arab_CN - kk_Cyrl - kk_Cyrl_KZ - kk_KZ - kkj - kkj_CM - kl - kl_GL - kln - kln_KE - km - km_KH - kn - kn_IN - ko - ko_CN - ko_KP - ko_KR - kok - kok_Deva - kok_Deva_IN - kok_Latn - kok_Latn_IN - kpe - kpe_GN - kpe_LR - ks - ks_Arab - ks_Arab_IN - ks_Deva - ks_Deva_IN - ksb - ksb_TZ - ksf - ksf_CM - ksh - ksh_DE - ku - ku_TR - kw - kw_GB - kxv - kxv_Deva - kxv_Deva_IN - kxv_Latn - kxv_Latn_IN - kxv_Orya - kxv_Orya_IN - kxv_Telu - kxv_Telu_IN - ky - ky_KG - la - la_VA - lag - lag_TZ - lb - lb_LU - lg - lg_UG - lij - lij_IT - lkt - lkt_US - lld - lld_IT - lmo - lmo_IT - ln - ln_AO - ln_CD - ln_CF - ln_CG - lo - lo_LA - lrc - lrc_IQ - lrc_IR - lt - lt_LT - ltg - ltg_LV - lu - lu_CD - luo - luo_KE - luy - luy_KE - lv - lv_LV - mai - mai_IN - mas - mas_KE - mas_TZ - mdf - mdf_RU - mer - mer_KE - mfe - mfe_MU - mg - mg_MG - mgh - mgh_MZ - mgo - mgo_CM - mhn - mhn_IT - mi - mi_NZ - mic - mic_CA - mk - mk_MK - ml - ml_IN - mn - mn_MN - mn_Mong - mn_Mong_CN - mn_Mong_MN - mni - mni_Beng - mni_Beng_IN - mni_Mtei - mni_Mtei_IN - moh - moh_CA - mr - mr_IN - ms - ms_Arab - ms_Arab_BN - ms_Arab_MY - ms_BN - ms_ID - ms_MY - ms_SG - mt - mt_MT - mua - mua_CM - mus - mus_US - my - my_MM - myv - myv_RU - mzn - mzn_IR - naq - naq_NA - nb - nb_NO - nb_SJ - nd - nd_ZW - nds - nds_DE - nds_NL - ne - ne_IN - ne_NP - nl - nl_AW - nl_BE - nl_BQ - nl_CW - nl_NL - nl_SR - nl_SX - nmg - nmg_CM - nn - nn_NO - nnh - nnh_CM - 'no' - nqo - nqo_GN - nr - nr_ZA - nso - nso_ZA - nus - nus_SS - nv - nv_US - ny - ny_MW - nyn - nyn_UG - oc - oc_ES - oc_FR - om - om_ET - om_KE - or - or_IN - os - os_GE - os_RU - osa - osa_US - pa - pa_Arab - pa_Arab_PK - pa_Guru - pa_Guru_IN - pap - pap_AW - pap_CW - pcm - pcm_NG - pis - pis_SB - pl - pl_PL - prg - prg_PL - ps - ps_AF - ps_PK - pt - pt_AO - pt_BR - pt_CH - pt_CV - pt_GQ - pt_GW - pt_LU - pt_MO - pt_MZ - pt_PT - pt_ST - pt_TL - qu - qu_BO - qu_EC - qu_PE - quc - quc_GT - raj - raj_IN - rhg - rhg_Rohg - rhg_Rohg_BD - rhg_Rohg_MM - rif - rif_MA - rm - rm_CH - rn - rn_BI - ro - ro_MD - ro_RO - rof - rof_TZ - ru - ru_BY - ru_KG - ru_KZ - ru_MD - ru_RU - ru_UA - rw - rw_RW - rwk - rwk_TZ - sa - sa_IN - sah - sah_RU - saq - saq_KE - sat - sat_Deva - sat_Deva_IN - sat_Olck - sat_Olck_IN - sbp - sbp_TZ - sc - sc_IT - scn - scn_IT - sd - sd_Arab - sd_Arab_PK - sd_Deva - sd_Deva_IN - sdh - sdh_IQ - sdh_IR - se - se_FI - se_NO - se_SE - seh - seh_MZ - ses - ses_ML - sg - sg_CF - shi - shi_Latn - shi_Latn_MA - shi_Tfng - shi_Tfng_MA - shn - shn_MM - shn_TH - si - si_LK - sid - sid_ET - sk - sk_SK - skr - skr_PK - sl - sl_SI - sma - sma_NO - sma_SE - smj - smj_NO - smj_SE - smn - smn_FI - sms - sms_FI - sn - sn_ZW - so - so_DJ - so_ET - so_KE - so_SO - sq - sq_AL - sq_MK - sq_XK - sr - sr_Cyrl - sr_Cyrl_BA - sr_Cyrl_ME - sr_Cyrl_RS - sr_Cyrl_XK - sr_Latn - sr_Latn_BA - sr_Latn_ME - sr_Latn_RS - sr_Latn_XK - ss - ss_SZ - ss_ZA - ssy - ssy_ER - st - st_LS - st_ZA - su - su_Latn - su_Latn_ID - sv - sv_AX - sv_FI - sv_SE - sw - sw_CD - sw_KE - sw_TZ - sw_UG - syr - syr_IQ - syr_SY - szl - szl_PL - ta - ta_IN - ta_LK - ta_MY - ta_SG - te - te_IN - teo - teo_KE - teo_UG - tg - tg_TJ - th - th_TH - ti - ti_ER - ti_ET - tig - tig_ER - tk - tk_TM - tn - tn_BW - tn_ZA - to - to_TO - tok - tok_001 - tpi - tpi_PG - tr - tr_CY - tr_TR - trv - trv_TW - trw - trw_PK - ts - ts_ZA - tt - tt_RU - twq - twq_NE - tyv - tyv_RU - tzm - tzm_MA - ug - ug_CN - uk - uk_UA - ur - ur_IN - ur_PK - uz - uz_Arab - uz_Arab_AF - uz_Cyrl - uz_Cyrl_UZ - uz_Latn - uz_Latn_UZ - vai - vai_Latn - vai_Latn_LR - vai_Vaii - vai_Vaii_LR - ve - ve_ZA - vec - vec_IT - vi - vi_VN - vmw - vmw_MZ - vo - vo_001 - vun - vun_TZ - wa - wa_BE - wae - wae_CH - wal - wal_ET - wbp - wbp_AU - wo - wo_SN - xh - xh_ZA - xnr - xnr_IN - xog - xog_UG - yav - yav_CM - yi - yi_UA - yo - yo_BJ - yo_NG - yrl - yrl_BR - yrl_CO - yrl_VE - yue - yue_Hans - yue_Hans_CN - yue_Hant - yue_Hant_CN - yue_Hant_HK - za - za_CN - zgh - zgh_MA - zh - zh_Hans - zh_Hans_CN - zh_Hans_HK - zh_Hans_MO - zh_Hans_MY - zh_Hans_SG - zh_Hant - zh_Hant_HK - zh_Hant_MO - zh_Hant_MY - zh_Hant_TW - zh_Latn - zh_Latn_CN - zu - zu_ZA timeformat: type: string readOnly: true timezone: type: string title: type: string nullable: true maxLength: 256 external_id: type: string nullable: true maxLength: 128 idp: $ref: '#/components/schemas/auth.IDPReference' domain: $ref: '#/components/schemas/auth.DomainUser' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string signed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: Serializer for full user representation with custom 'events' required: - email - timezone - idp - domain auth.UserAccount: properties: id: type: string readOnly: true name: type: string maxLength: 64 icon: type: string format: binary nullable: true description: type: string nullable: true maxLength: 512 overview: type: string nullable: true headquarters: type: string nullable: true maxLength: 256 type: type: string enum: - vendor - provider role: type: string enum: - vendor - distributor - reseller brand: type: string maxLength: 100 external_id: type: string maxLength: 100 sourcing: type: boolean description: This flag enables sourcing to other providers through catalog countries: type: array items: {} nullable: true description: 'Template (ISO 3166 Alpha 2: List of codes):
[
"GB",
"RU"
]' languages: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] websites: type: array items: type: string nullable: true description: Template:
[
"https://example.com",
"http://cloudblue.com/"
] industries: type: array items: $ref: '#/components/schemas/auth.Industry' public: type: boolean nullable: true description: Flag to show Account data in public CB catalog. events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true permissions: type: object readOnly: true groups: type: array items: $ref: '#/components/schemas/auth.GroupBase' readOnly: true settings: $ref: '#/components/schemas/auth.AccountSettings' readOnly: true type: object required: - name auth.UserContact: properties: id: type: string readOnly: true type: type: string enum: - phone value: $ref: '#/components/schemas/auth.Phone' readOnly: true status: type: string enum: - draft - pending - verified - deleted events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string verified: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true tags: type: array items: $ref: '#/components/schemas/auth.Tag' type: object required: - type - status - tags auth.UserContactCreate: properties: type: type: string enum: - phone value: $ref: '#/components/schemas/auth.Phone' type: object required: - type - value auth.UserContactUpdate: properties: tags: type: array items: $ref: '#/components/schemas/auth.IdWrite' type: object auth.UserCreate: properties: email: type: string format: email maxLength: 254 name: type: string maxLength: 128 icon: type: string format: binary nullable: true title: type: string nullable: true maxLength: 256 region: type: string enum: - aa - aa_DJ - aa_ER - aa_ET - ab - ab_GE - af - af_NA - af_ZA - agq - agq_CM - ak - ak_GH - am - am_ET - an - an_ES - ann - ann_NG - apc - apc_SY - ar - ar_001 - ar_AE - ar_BH - ar_DJ - ar_DZ - ar_EG - ar_EH - ar_ER - ar_IL - ar_IQ - ar_JO - ar_KM - ar_KW - ar_LB - ar_LY - ar_MA - ar_MR - ar_OM - ar_PS - ar_QA - ar_SA - ar_SD - ar_SO - ar_SS - ar_SY - ar_TD - ar_TN - ar_YE - arn - arn_CL - as - as_IN - asa - asa_TZ - ast - ast_ES - az - az_Arab - az_Arab_IQ - az_Arab_IR - az_Arab_TR - az_Cyrl - az_Cyrl_AZ - az_Latn - az_Latn_AZ - ba - ba_RU - bal - bal_Arab - bal_Arab_PK - bal_Latn - bal_Latn_PK - bas - bas_CM - be - be_BY - be_TARASK - bem - bem_ZM - bew - bew_ID - bez - bez_TZ - bg - bg_BG - bgc - bgc_IN - bgn - bgn_AE - bgn_AF - bgn_IR - bgn_OM - bgn_PK - bho - bho_IN - blo - blo_BJ - blt - blt_VN - bm - bm_ML - bm_Nkoo - bm_Nkoo_ML - bn - bn_BD - bn_IN - bo - bo_CN - bo_IN - br - br_FR - brx - brx_IN - bs - bs_Cyrl - bs_Cyrl_BA - bs_Latn - bs_Latn_BA - bss - bss_CM - byn - byn_ER - ca - ca_AD - ca_ES - ca_ES_VALENCIA - ca_FR - ca_IT - cad - cad_US - cch - cch_NG - ccp - ccp_BD - ccp_IN - ce - ce_RU - ceb - ceb_PH - cgg - cgg_UG - cho - cho_US - chr - chr_US - cic - cic_US - ckb - ckb_IQ - ckb_IR - co - co_FR - cs - cs_CZ - csw - csw_CA - cu - cu_RU - cv - cv_RU - cy - cy_GB - da - da_DK - da_GL - dav - dav_KE - de - de_AT - de_BE - de_CH - de_DE - de_IT - de_LI - de_LU - dje - dje_NE - doi - doi_IN - dsb - dsb_DE - dua - dua_CM - dv - dv_MV - dyo - dyo_SN - dz - dz_BT - ebu - ebu_KE - ee - ee_GH - ee_TG - el - el_CY - el_GR - el_POLYTON - en - en_001 - en_150 - en_AE - en_AG - en_AI - en_AS - en_AT - en_AU - en_BB - en_BE - en_BI - en_BM - en_BS - en_BW - en_BZ - en_CA - en_CC - en_CH - en_CK - en_CM - en_CX - en_CY - en_DE - en_DG - en_DK - en_DM - en_Dsrt - en_Dsrt_US - en_ER - en_FI - en_FJ - en_FK - en_FM - en_GB - en_GD - en_GG - en_GH - en_GI - en_GM - en_GU - en_GY - en_HK - en_ID - en_IE - en_IL - en_IM - en_IN - en_IO - en_JE - en_JM - en_KE - en_KI - en_KN - en_KY - en_LC - en_LR - en_LS - en_MG - en_MH - en_MO - en_MP - en_MS - en_MT - en_MU - en_MV - en_MW - en_MY - en_NA - en_NF - en_NG - en_NL - en_NR - en_NU - en_NZ - en_PG - en_PH - en_PK - en_PN - en_PR - en_PW - en_RW - en_SB - en_SC - en_SD - en_SE - en_SG - en_SH - en_SI - en_SL - en_SS - en_SX - en_SZ - en_Shaw - en_Shaw_GB - en_TC - en_TK - en_TO - en_TT - en_TV - en_TZ - en_UG - en_UM - en_US - en_US_POSIX - en_VC - en_VG - en_VI - en_VU - en_WS - en_ZA - en_ZM - en_ZW - eo - eo_001 - es - es_419 - es_AR - es_BO - es_BR - es_BZ - es_CL - es_CO - es_CR - es_CU - es_DO - es_EA - es_EC - es_ES - es_GQ - es_GT - es_HN - es_IC - es_MX - es_NI - es_PA - es_PE - es_PH - es_PR - es_PY - es_SV - es_US - es_UY - es_VE - et - et_EE - eu - eu_ES - ewo - ewo_CM - fa - fa_AF - fa_IR - ff - ff_Adlm - ff_Adlm_BF - ff_Adlm_CM - ff_Adlm_GH - ff_Adlm_GM - ff_Adlm_GN - ff_Adlm_GW - ff_Adlm_LR - ff_Adlm_MR - ff_Adlm_NE - ff_Adlm_NG - ff_Adlm_SL - ff_Adlm_SN - ff_Latn - ff_Latn_BF - ff_Latn_CM - ff_Latn_GH - ff_Latn_GM - ff_Latn_GN - ff_Latn_GW - ff_Latn_LR - ff_Latn_MR - ff_Latn_NE - ff_Latn_NG - ff_Latn_SL - ff_Latn_SN - fi - fi_FI - fil - fil_PH - fo - fo_DK - fo_FO - fr - fr_BE - fr_BF - fr_BI - fr_BJ - fr_BL - fr_CA - fr_CD - fr_CF - fr_CG - fr_CH - fr_CI - fr_CM - fr_DJ - fr_DZ - fr_FR - fr_GA - fr_GF - fr_GN - fr_GP - fr_GQ - fr_HT - fr_KM - fr_LU - fr_MA - fr_MC - fr_MF - fr_MG - fr_ML - fr_MQ - fr_MR - fr_MU - fr_NC - fr_NE - fr_PF - fr_PM - fr_RE - fr_RW - fr_SC - fr_SN - fr_SY - fr_TD - fr_TG - fr_TN - fr_VU - fr_WF - fr_YT - frr - frr_DE - fur - fur_IT - fy - fy_NL - ga - ga_GB - ga_IE - gaa - gaa_GH - gd - gd_GB - gez - gez_ER - gez_ET - gl - gl_ES - gn - gn_PY - gsw - gsw_CH - gsw_FR - gsw_LI - gu - gu_IN - guz - guz_KE - gv - gv_IM - ha - ha_Arab - ha_Arab_NG - ha_Arab_SD - ha_GH - ha_NE - ha_NG - haw - haw_US - he - he_IL - hi - hi_IN - hi_Latn - hi_Latn_IN - hnj - hnj_Hmnp - hnj_Hmnp_US - hr - hr_BA - hr_HR - hsb - hsb_DE - hu - hu_HU - hy - hy_AM - ia - ia_001 - id - id_ID - ie - ie_EE - ig - ig_NG - ii - ii_CN - io - io_001 - is - is_IS - it - it_CH - it_IT - it_SM - it_VA - iu - iu_CA - iu_Latn - iu_Latn_CA - ja - ja_JP - jbo - jbo_001 - jgo - jgo_CM - jmc - jmc_TZ - jv - jv_ID - ka - ka_GE - kaa - kaa_Cyrl - kaa_Cyrl_UZ - kaa_Latn - kaa_Latn_UZ - kab - kab_DZ - kaj - kaj_NG - kam - kam_KE - kcg - kcg_NG - kde - kde_TZ - kea - kea_CV - ken - ken_CM - kgp - kgp_BR - khq - khq_ML - ki - ki_KE - kk - kk_Arab - kk_Arab_CN - kk_Cyrl - kk_Cyrl_KZ - kk_KZ - kkj - kkj_CM - kl - kl_GL - kln - kln_KE - km - km_KH - kn - kn_IN - ko - ko_CN - ko_KP - ko_KR - kok - kok_Deva - kok_Deva_IN - kok_Latn - kok_Latn_IN - kpe - kpe_GN - kpe_LR - ks - ks_Arab - ks_Arab_IN - ks_Deva - ks_Deva_IN - ksb - ksb_TZ - ksf - ksf_CM - ksh - ksh_DE - ku - ku_TR - kw - kw_GB - kxv - kxv_Deva - kxv_Deva_IN - kxv_Latn - kxv_Latn_IN - kxv_Orya - kxv_Orya_IN - kxv_Telu - kxv_Telu_IN - ky - ky_KG - la - la_VA - lag - lag_TZ - lb - lb_LU - lg - lg_UG - lij - lij_IT - lkt - lkt_US - lld - lld_IT - lmo - lmo_IT - ln - ln_AO - ln_CD - ln_CF - ln_CG - lo - lo_LA - lrc - lrc_IQ - lrc_IR - lt - lt_LT - ltg - ltg_LV - lu - lu_CD - luo - luo_KE - luy - luy_KE - lv - lv_LV - mai - mai_IN - mas - mas_KE - mas_TZ - mdf - mdf_RU - mer - mer_KE - mfe - mfe_MU - mg - mg_MG - mgh - mgh_MZ - mgo - mgo_CM - mhn - mhn_IT - mi - mi_NZ - mic - mic_CA - mk - mk_MK - ml - ml_IN - mn - mn_MN - mn_Mong - mn_Mong_CN - mn_Mong_MN - mni - mni_Beng - mni_Beng_IN - mni_Mtei - mni_Mtei_IN - moh - moh_CA - mr - mr_IN - ms - ms_Arab - ms_Arab_BN - ms_Arab_MY - ms_BN - ms_ID - ms_MY - ms_SG - mt - mt_MT - mua - mua_CM - mus - mus_US - my - my_MM - myv - myv_RU - mzn - mzn_IR - naq - naq_NA - nb - nb_NO - nb_SJ - nd - nd_ZW - nds - nds_DE - nds_NL - ne - ne_IN - ne_NP - nl - nl_AW - nl_BE - nl_BQ - nl_CW - nl_NL - nl_SR - nl_SX - nmg - nmg_CM - nn - nn_NO - nnh - nnh_CM - 'no' - nqo - nqo_GN - nr - nr_ZA - nso - nso_ZA - nus - nus_SS - nv - nv_US - ny - ny_MW - nyn - nyn_UG - oc - oc_ES - oc_FR - om - om_ET - om_KE - or - or_IN - os - os_GE - os_RU - osa - osa_US - pa - pa_Arab - pa_Arab_PK - pa_Guru - pa_Guru_IN - pap - pap_AW - pap_CW - pcm - pcm_NG - pis - pis_SB - pl - pl_PL - prg - prg_PL - ps - ps_AF - ps_PK - pt - pt_AO - pt_BR - pt_CH - pt_CV - pt_GQ - pt_GW - pt_LU - pt_MO - pt_MZ - pt_PT - pt_ST - pt_TL - qu - qu_BO - qu_EC - qu_PE - quc - quc_GT - raj - raj_IN - rhg - rhg_Rohg - rhg_Rohg_BD - rhg_Rohg_MM - rif - rif_MA - rm - rm_CH - rn - rn_BI - ro - ro_MD - ro_RO - rof - rof_TZ - ru - ru_BY - ru_KG - ru_KZ - ru_MD - ru_RU - ru_UA - rw - rw_RW - rwk - rwk_TZ - sa - sa_IN - sah - sah_RU - saq - saq_KE - sat - sat_Deva - sat_Deva_IN - sat_Olck - sat_Olck_IN - sbp - sbp_TZ - sc - sc_IT - scn - scn_IT - sd - sd_Arab - sd_Arab_PK - sd_Deva - sd_Deva_IN - sdh - sdh_IQ - sdh_IR - se - se_FI - se_NO - se_SE - seh - seh_MZ - ses - ses_ML - sg - sg_CF - shi - shi_Latn - shi_Latn_MA - shi_Tfng - shi_Tfng_MA - shn - shn_MM - shn_TH - si - si_LK - sid - sid_ET - sk - sk_SK - skr - skr_PK - sl - sl_SI - sma - sma_NO - sma_SE - smj - smj_NO - smj_SE - smn - smn_FI - sms - sms_FI - sn - sn_ZW - so - so_DJ - so_ET - so_KE - so_SO - sq - sq_AL - sq_MK - sq_XK - sr - sr_Cyrl - sr_Cyrl_BA - sr_Cyrl_ME - sr_Cyrl_RS - sr_Cyrl_XK - sr_Latn - sr_Latn_BA - sr_Latn_ME - sr_Latn_RS - sr_Latn_XK - ss - ss_SZ - ss_ZA - ssy - ssy_ER - st - st_LS - st_ZA - su - su_Latn - su_Latn_ID - sv - sv_AX - sv_FI - sv_SE - sw - sw_CD - sw_KE - sw_TZ - sw_UG - syr - syr_IQ - syr_SY - szl - szl_PL - ta - ta_IN - ta_LK - ta_MY - ta_SG - te - te_IN - teo - teo_KE - teo_UG - tg - tg_TJ - th - th_TH - ti - ti_ER - ti_ET - tig - tig_ER - tk - tk_TM - tn - tn_BW - tn_ZA - to - to_TO - tok - tok_001 - tpi - tpi_PG - tr - tr_CY - tr_TR - trv - trv_TW - trw - trw_PK - ts - ts_ZA - tt - tt_RU - twq - twq_NE - tyv - tyv_RU - tzm - tzm_MA - ug - ug_CN - uk - uk_UA - ur - ur_IN - ur_PK - uz - uz_Arab - uz_Arab_AF - uz_Cyrl - uz_Cyrl_UZ - uz_Latn - uz_Latn_UZ - vai - vai_Latn - vai_Latn_LR - vai_Vaii - vai_Vaii_LR - ve - ve_ZA - vec - vec_IT - vi - vi_VN - vmw - vmw_MZ - vo - vo_001 - vun - vun_TZ - wa - wa_BE - wae - wae_CH - wal - wal_ET - wbp - wbp_AU - wo - wo_SN - xh - xh_ZA - xnr - xnr_IN - xog - xog_UG - yav - yav_CM - yi - yi_UA - yo - yo_BJ - yo_NG - yrl - yrl_BR - yrl_CO - yrl_VE - yue - yue_Hans - yue_Hans_CN - yue_Hant - yue_Hant_CN - yue_Hant_HK - za - za_CN - zgh - zgh_MA - zh - zh_Hans - zh_Hans_CN - zh_Hans_HK - zh_Hans_MO - zh_Hans_MY - zh_Hans_SG - zh_Hant - zh_Hant_HK - zh_Hant_MO - zh_Hant_MY - zh_Hant_TW - zh_Latn - zh_Latn_CN - zu - zu_ZA timezone: type: string enum: - America/Montreal - America/Atikokan - Navajo - America/Montevideo - America/Buenos_Aires - America/Guadeloupe - Europe/Helsinki - Africa/Bissau - Australia/Brisbane - Asia/Dacca - America/Toronto - Europe/Simferopol - Hongkong - Asia/Dhaka - Etc/GMT-8 - Atlantic/St_Helena - America/Havana - Brazil/East - Europe/Vaduz - America/Marigot - Africa/Kigali - Pacific/Palau - Europe/Sofia - Antarctica/South_Pole - Europe/Ulyanovsk - America/Knox_IN - Asia/Famagusta - Pacific/Saipan - America/Costa_Rica - Asia/Seoul - NZ - Indian/Mauritius - US/Eastern - Asia/Yangon - America/Rankin_Inlet - Africa/Timbuktu - America/El_Salvador - America/Mendoza - Asia/Novokuznetsk - America/Santiago - Asia/Chongqing - Europe/Tallinn - America/Cuiaba - Europe/Moscow - America/Port_of_Spain - America/Argentina/Jujuy - America/Indiana/Vincennes - Atlantic/Reykjavik - Europe/Copenhagen - America/Rio_Branco - Asia/Singapore - Brazil/West - Asia/Srednekolymsk - ROK - America/Regina - Canada/Yukon - Africa/Banjul - Africa/Lusaka - Chile/EasterIsland - America/Paramaribo - Europe/Athens - Atlantic/Stanley - Europe/Stockholm - Europe/Paris - Africa/Bamako - Asia/Chungking - America/Miquelon - Asia/Ujung_Pandang - Asia/Bangkok - Atlantic/Cape_Verde - America/Guyana - America/Manaus - Asia/Kolkata - Atlantic/Bermuda - Africa/Abidjan - US/East-Indiana - Pacific/Pohnpei - Africa/Lubumbashi - Pacific/Truk - Pacific/Bougainville - GMT0 - Asia/Makassar - Asia/Rangoon - America/Indiana/Winamac - America/Cayenne - Asia/Omsk - Australia/Sydney - Etc/GMT-11 - America/Cayman - Asia/Baghdad - America/Scoresbysund - Africa/Ndjamena - America/Jujuy - GMT-0 - Antarctica/Palmer - Africa/Monrovia - Australia/Queensland - Europe/Kirov - Africa/Ceuta - Pacific/Guadalcanal - Australia/LHI - Mexico/BajaSur - Asia/Krasnoyarsk - Africa/Mogadishu - Asia/Ashgabat - Pacific/Kosrae - Asia/Harbin - Asia/Magadan - Canada/Atlantic - America/Port-au-Prince - America/Bogota - America/Goose_Bay - Pacific/Enderbury - EST5EDT - Europe/Belfast - Asia/Macao - Asia/Tehran - Asia/Kashgar - America/Grand_Turk - Pacific/Fakaofo - Canada/Mountain - Etc/GMT-3 - America/St_Johns - America/St_Barthelemy - America/Hermosillo - Etc/GMT+7 - MET - Africa/Mbabane - Etc/GMT+3 - America/Indiana/Vevay - Canada/Saskatchewan - Pacific/Pitcairn - America/Thule - Chile/Continental - Pacific/Chatham - America/Argentina/La_Rioja - Africa/Niamey - America/Santa_Isabel - Asia/Aqtau - Etc/Zulu - America/Barbados - Europe/Guernsey - Antarctica/Syowa - Asia/Ho_Chi_Minh - Asia/Baku - Etc/GMT+10 - Etc/GMT-5 - America/Araguaina - Africa/Conakry - Atlantic/Canary - Europe/Kaliningrad - America/St_Lucia - America/Cambridge_Bay - Cuba - US/Hawaii - Africa/Ouagadougou - America/Argentina/San_Juan - Africa/Nouakchott - PST8PDT - Asia/Bahrain - Canada/Pacific - Asia/Vientiane - America/Nipigon - Asia/Brunei - Africa/Porto-Novo - America/Montserrat - Africa/Sao_Tome - Pacific/Yap - Etc/GMT+2 - Africa/Maseru - Antarctica/Davis - Asia/Pontianak - Antarctica/Casey - Asia/Choibalsan - Libya - Pacific/Guam - Australia/NSW - America/Iqaluit - America/Asuncion - America/Ojinaga - Asia/Samarkand - America/Nassau - CET - Asia/Gaza - Europe/Prague - Israel - America/Yellowknife - Asia/Almaty - Africa/Algiers - Africa/Douala - America/Thunder_Bay - Africa/Freetown - Indian/Maldives - America/Mazatlan - Pacific/Marquesas - America/Indiana/Marengo - Australia/North - GB - America/Argentina/Buenos_Aires - America/Glace_Bay - Asia/Manila - Australia/Lindeman - Africa/Maputo - Pacific/Pago_Pago - Pacific/Fiji - America/Kralendijk - America/Dawson_Creek - Africa/Nairobi - Asia/Ulaanbaatar - Europe/Ljubljana - Atlantic/Jan_Mayen - America/Phoenix - HST - Etc/GMT+1 - Africa/Tunis - Pacific/Tahiti - America/Pangnirtung - America/Denver - Etc/GMT+6 - Atlantic/Madeira - Indian/Comoro - America/Argentina/Catamarca - America/Juneau - Africa/Djibouti - Asia/Saigon - America/Nome - Australia/Perth - Asia/Barnaul - US/Aleutian - Africa/Bujumbura - America/Swift_Current - Asia/Irkutsk - Europe/Minsk - America/Tijuana - Africa/Addis_Ababa - America/Winnipeg - Australia/Hobart - Antarctica/Mawson - America/Lima - Etc/GMT+4 - America/Moncton - Pacific/Noumea - Europe/Uzhgorod - Africa/Blantyre - Etc/UCT - Australia/Broken_Hill - Brazil/Acre - Europe/Riga - America/Caracas - America/St_Kitts - Australia/South - America/Tortola - US/Arizona - Europe/Sarajevo - GMT+0 - Europe/Luxembourg - America/Belem - Europe/Brussels - Indian/Mahe - MST - Europe/Busingen - Europe/Malta - America/Guatemala - Asia/Qostanay - Pacific/Honolulu - Etc/GMT-2 - Etc/GMT - Pacific/Tarawa - America/Monterrey - Antarctica/Rothera - Asia/Pyongyang - NZ-CHAT - Europe/Vienna - America/Bahia - Asia/Thimbu - Etc/GMT0 - America/Menominee - Africa/Libreville - Mexico/BajaNorte - Asia/Muscat - America/Coral_Harbour - Australia/Melbourne - Africa/Bangui - America/St_Thomas - Canada/Eastern - Asia/Tel_Aviv - Asia/Novosibirsk - Australia/Adelaide - Canada/Newfoundland - America/Managua - Asia/Jayapura - America/Lower_Princes - Indian/Reunion - America/Edmonton - W-SU - America/Rosario - Indian/Antananarivo - Australia/Currie - Asia/Kuwait - America/North_Dakota/Center - Europe/Monaco - Universal - America/Argentina/Cordoba - Canada/Central - Africa/Juba - Asia/Kuching - Europe/Bucharest - Asia/Atyrau - Asia/Kathmandu - Pacific/Nauru - Europe/Vilnius - Asia/Macau - Africa/Luanda - Africa/Johannesburg - Australia/Victoria - Africa/El_Aaiun - Australia/Darwin - Africa/Dakar - Africa/Accra - America/Inuvik - America/Antigua - America/Puerto_Rico - America/Ciudad_Juarez - America/Halifax - Factory - GMT - America/Aruba - Asia/Dili - America/Dominica - Pacific/Ponape - America/Shiprock - Asia/Qyzylorda - Europe/Zurich - Asia/Damascus - America/Boa_Vista - Australia/Lord_Howe - Asia/Tbilisi - Africa/Khartoum - Europe/Zagreb - Pacific/Auckland - Africa/Kinshasa - Pacific/Midway - Asia/Aqtobe - Europe/Kiev - America/Indiana/Knox - Asia/Tomsk - America/Argentina/Ushuaia - America/Argentina/Mendoza - Europe/Bratislava - America/Boise - America/Catamarca - Asia/Jerusalem - Europe/Podgorica - Asia/Yerevan - America/Yakutat - Africa/Brazzaville - Iceland - Asia/Dushanbe - America/Argentina/Rio_Gallegos - Brazil/DeNoronha - Etc/GMT-10 - Portugal - Asia/Vladivostok - America/Cordoba - America/Curacao - Mexico/General - America/Whitehorse - EST - America/New_York - Asia/Hong_Kong - Indian/Kerguelen - Asia/Oral - America/Blanc-Sablon - Etc/GMT+9 - Europe/Saratov - America/North_Dakota/New_Salem - America/Belize - Europe/Belgrade - America/Sitka - Asia/Hovd - Asia/Taipei - Asia/Tokyo - Europe/Tirane - Europe/Warsaw - US/Alaska - Pacific/Efate - Africa/Kampala - Arctic/Longyearbyen - Antarctica/Troll - Asia/Yekaterinburg - Etc/GMT+5 - Pacific/Kwajalein - America/Indianapolis - localtime - Europe/Budapest - Europe/Berlin - Etc/GMT-9 - America/St_Vincent - Pacific/Kanton - Australia/Tasmania - Eire - Europe/Vatican - MST7MDT - America/Guayaquil - Kwajalein - Africa/Malabo - Poland - America/Virgin - Pacific/Rarotonga - Europe/Volgograd - Pacific/Kiritimati - America/Mexico_City - Asia/Karachi - Europe/Astrakhan - Singapore - Asia/Katmandu - Asia/Kabul - America/Godthab - Africa/Asmara - Australia/Canberra - America/La_Paz - Etc/GMT-0 - Africa/Asmera - Pacific/Apia - America/Recife - Europe/Madrid - Europe/Skopje - America/Porto_Velho - Europe/Mariehamn - America/Indiana/Petersburg - America/Maceio - America/Los_Angeles - Atlantic/Faroe - America/Atka - Asia/Hebron - Africa/Lagos - Etc/UTC - Europe/Nicosia - Australia/West - Asia/Beirut - Asia/Ulan_Bator - America/Noronha - America/Jamaica - Asia/Thimphu - Asia/Phnom_Penh - America/Argentina/San_Luis - Etc/GMT+8 - PRC - Etc/GMT+11 - GB-Eire - America/North_Dakota/Beulah - Etc/GMT-6 - Antarctica/Macquarie - Africa/Lome - Asia/Khandyga - Asia/Aden - America/Anchorage - Turkey - Europe/London - Africa/Casablanca - Asia/Bishkek - Iran - Asia/Qatar - Europe/Oslo - America/Argentina/Tucuman - America/Porto_Acre - America/Tegucigalpa - US/Pacific - Greenwich - America/Merida - Pacific/Easter - America/Nuuk - US/Michigan - Europe/Jersey - Pacific/Funafuti - Asia/Ust-Nera - America/Detroit - Etc/GMT-13 - Asia/Ashkhabad - UCT - America/Sao_Paulo - Europe/Chisinau - Australia/Yancowinna - America/Campo_Grande - America/Creston - America/Martinique - Europe/Andorra - Asia/Tashkent - Etc/GMT-1 - Asia/Istanbul - Etc/GMT-4 - Pacific/Johnston - America/Indiana/Indianapolis - America/Bahia_Banderas - America/Argentina/Salta - Africa/Cairo - WET - UTC - Asia/Anadyr - America/Danmarkshavn - America/Louisville - America/Ensenada - America/Matamoros - Australia/ACT - Pacific/Gambier - America/Chicago - Asia/Jakarta - America/Indiana/Tell_City - Europe/Samara - Pacific/Galapagos - Etc/GMT+0 - US/Indiana-Starke - Pacific/Majuro - Asia/Chita - America/Panama - Europe/Amsterdam - US/Samoa - Europe/Tiraspol - Zulu - Africa/Windhoek - Europe/Kyiv - Pacific/Chuuk - Egypt - Europe/Istanbul - America/Adak - America/Kentucky/Louisville - Pacific/Samoa - Pacific/Port_Moresby - Europe/Gibraltar - America/Dawson - Atlantic/Azores - America/Kentucky/Monticello - America/Santo_Domingo - America/Anguilla - America/Metlakatla - Asia/Shanghai - Indian/Christmas - EET - US/Central - America/Vancouver - Atlantic/Faeroe - Europe/Isle_of_Man - Asia/Sakhalin - Antarctica/DumontDUrville - Asia/Riyadh - Africa/Tripoli - America/Fort_Nelson - America/Fortaleza - Pacific/Wallis - Europe/Rome - America/Cancun - Asia/Urumqi - America/Santarem - Indian/Cocos - Asia/Nicosia - Africa/Harare - Asia/Colombo - America/Punta_Arenas - Asia/Amman - Atlantic/South_Georgia - Etc/GMT-7 - America/Argentina/ComodRivadavia - Europe/Zaporozhye - Asia/Yakutsk - America/Fort_Wayne - Pacific/Norfolk - Etc/GMT-12 - Jamaica - CST6CDT - America/Grenada - Europe/Lisbon - US/Mountain - Etc/Universal - Asia/Dubai - Etc/GMT-14 - Africa/Gaborone - Europe/San_Marino - America/Eirunepe - Europe/Dublin - Indian/Mayotte - Antarctica/Vostok - America/Chihuahua - Etc/GMT+12 - Asia/Kuala_Lumpur - Pacific/Niue - ROC - Africa/Dar_es_Salaam - Pacific/Wake - Pacific/Tongatapu - Australia/Eucla - Asia/Kamchatka - Asia/Calcutta - Antarctica/McMurdo - Etc/Greenwich - America/Rainy_River - America/Resolute - Japan - Indian/Chagos timeformat: type: string announcements: type: boolean default: true description: Receive marketing news and announcements type: object required: - email - name auth.UserSession: properties: id: type: string readOnly: true status: type: string enum: - active - deleted - expired - terminated nullable: true host: type: string nullable: true maxLength: 256 location: type: object properties: ip: type: string country: type: object properties: id: type: string name: type: string city: type: string readOnly: true device: type: object properties: browser: type: string os: type: string ua: type: string readOnly: true current: type: boolean readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string deleted: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string expired: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string impersonated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object auth._AccountExtensionConstraints: properties: tokens: type: integer maximum: 32 minimum: 0 type: object required: - tokens auth._AccountPermissionsWrite: properties: agreement: $ref: '#/components/schemas/auth._AgreementPermissionsWrite' type: object required: - agreement auth._AgreementPermissionsWrite: properties: program: $ref: '#/components/schemas/auth._ProgramAgreementPermissionsWrite' service: $ref: '#/components/schemas/auth._ServiceAgreementPermissionsWrite' type: object required: - program - service auth._ExtensionConstraints: properties: account: $ref: '#/components/schemas/auth._AccountExtensionConstraints' type: object auth._ExtensionWrite: properties: id: type: string writeOnly: true name: type: string writeOnly: true type: object auth._IDPGroupAttributeSettings: properties: external_id: type: string maxLength: 256 type: object auth._IDPGroupSettings: properties: attributes: $ref: '#/components/schemas/auth._IDPGroupAttributeSettings' auto: type: boolean type: object auth._IDPSettings: properties: entity_id: type: string maxLength: 256 sso: $ref: '#/components/schemas/auth._URLObject' slo: $ref: '#/components/schemas/auth._URLObject' x509cert: type: string maxLength: 8192 user: $ref: '#/components/schemas/auth._IDPUserSettings' group: $ref: '#/components/schemas/auth._IDPGroupSettings' type: object auth._IDPUserAttributeSettings: properties: external_id: type: string maxLength: 256 email: type: string maxLength: 256 name: type: string maxLength: 256 type: object auth._IDPUserSettings: properties: attributes: $ref: '#/components/schemas/auth._IDPUserAttributeSettings' notice: type: string nullable: true maxLength: 1024 type: object auth._ProgramAgreementPermissionsWrite: properties: create: type: boolean type: object required: - create auth._ServiceAgreementPermissionsWrite: properties: create: type: boolean delegate: type: boolean type: object required: - create - delegate auth._URLObject: properties: url: type: string format: uri binding: type: string readOnly: true maxLength: 64 type: object required: - url branding.Account: properties: id: type: string readOnly: true name: type: string readOnly: true icon: type: string nullable: true maxLength: 2000 type: object description: 'Connect Account details. `id` -- id of the account. `name` -- name of the account. `icon` -- icon of the account.' branding.Brand: properties: id: type: string readOnly: true subdomain: type: string maxLength: 100 name: type: string maxLength: 100 owner: $ref: '#/components/schemas/branding.Account' public_api: type: string readOnly: true extensions: type: string readOnly: true customization: type: string readOnly: true base_domain: type: string readOnly: true type: object required: - subdomain branding.BrandReference: properties: id: type: string readOnly: true name: type: string maxLength: 100 public_api: type: string maxLength: 100 type: object required: - name - public_api branding.CaseField: properties: id: type: string type: object required: - id branding.CustomizationField: properties: email: type: string email_name: type: string email_footer: type: string messages: type: object type: object required: - email - email_name - email_footer - messages branding.Domain: properties: id: type: string readOnly: true domain: type: string readOnly: true type: type: string enum: - built_in - custom readOnly: true description: type: string readOnly: true nullable: true maxLength: 4000 portal: $ref: '#/components/schemas/branding.PortalReference' checks: $ref: '#/components/schemas/branding.DomainChecks' owner: $ref: '#/components/schemas/branding.Account' events: type: object properties: updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - description branding.DomainCheckCnameStatus: properties: status: type: string enum: - verified - failed - legacy events: $ref: '#/components/schemas/branding.DomainCheckCnameStatusEvents' type: object required: - events branding.DomainCheckCnameStatusEvents: properties: verified: $ref: '#/components/schemas/branding.DomainCheckCnameVerifiedAtDomain' failed: $ref: '#/components/schemas/branding.DomainCheckCnameStatusFailed' type: object required: - verified - failed branding.DomainCheckCnameStatusFailed: properties: at: type: string format: date-time nullable: true reason: type: string nullable: true maxLength: 256 type: object branding.DomainCheckCnameVerifiedAtDomain: properties: at: type: string format: date-time nullable: true type: object branding.DomainCheckHttpStatus: properties: status: type: string enum: - verified - failed events: $ref: '#/components/schemas/branding.DomainCheckHttpStatusEvents' type: object required: - events branding.DomainCheckHttpStatusEvents: properties: verified: $ref: '#/components/schemas/branding.DomainCheckHttpVerifiedAtDomain' failed: $ref: '#/components/schemas/branding.DomainCheckHttpStatusFailed' type: object required: - verified - failed branding.DomainCheckHttpStatusFailed: properties: at: type: string format: date-time nullable: true reason: type: string nullable: true maxLength: 256 type: object branding.DomainCheckHttpVerifiedAtDomain: properties: at: type: string format: date-time nullable: true type: object branding.DomainChecks: properties: http_status: $ref: '#/components/schemas/branding.DomainCheckHttpStatus' cname_record: $ref: '#/components/schemas/branding.DomainCheckCnameStatus' type: object required: - http_status - cname_record branding.FaviconReferenceField: properties: svg: type: string format: binary writeOnly: true type: object required: - svg branding.FooterField: properties: content: type: string type: object required: - content branding.Marketplace: properties: id: type: string readOnly: true name: type: string maxLength: 255 icon: type: string nullable: true maxLength: 2000 type: object description: 'Connect Marketplace details. `id` -- id of the marketplace. `name` -- name of the marketplace. `icon` -- icon of the marketplace.' required: - name branding.MarketplaceReference: properties: id: type: string icon: type: string readOnly: true nullable: true name: type: string readOnly: true type: object required: - id branding.Portal: properties: id: type: string readOnly: true subdomain: type: string readOnly: true maxLength: 100 domains: type: string type: type: string enum: - vendor - provider - customer - universal readOnly: true case: $ref: '#/components/schemas/branding.CaseField' analytics_key: type: string nullable: true maxLength: 100 theme: $ref: '#/components/schemas/branding.ThemField' urls: $ref: '#/components/schemas/branding.UrlField' title: type: string maxLength: 40 footer: $ref: '#/components/schemas/branding.FooterField' customization: $ref: '#/components/schemas/branding.CustomizationField' brand: $ref: '#/components/schemas/branding.BrandReference' marketplace: $ref: '#/components/schemas/branding.MarketplaceReference' language: type: string enum: - en - af - sq - ar - hy - az - eu - be - bg - ca - zh-CN - zh-TW - hr - cs - da - nl - et - tl - fi - fr - de - el - hu - id - ga - it - ja - ko - lt - ms - 'no' - pl - pt - ro - ru - es - sv - th - tr - uk nullable: true signin: $ref: '#/components/schemas/branding.SignInField' type: object required: - marketplace branding.PortalReference: properties: id: type: string readOnly: true type: type: string enum: - vendor - provider - customer - universal readOnly: true marketplace: $ref: '#/components/schemas/branding.Marketplace' subdomain: type: string readOnly: true title: type: string readOnly: true type: object required: - marketplace branding.SignInField: properties: help: type: string type: object required: - help branding.ThemField: properties: primary: type: string navigation: type: string accent: type: string type: object required: - primary - navigation - accent branding.UrlField: properties: sign_up: type: string tos: type: string logo: type: string format: binary favicons: $ref: '#/components/schemas/branding.FaviconReferenceField' type: object required: - sign_up - tos - logo - favicons conversations.Account: properties: id: type: string name: type: string readOnly: true icon: type: string nullable: true maxLength: 2000 type: object description: 'Connect Account details. `id` -- id of the account. `name` -- name of the account. `icon` -- icon of the account.' required: - id conversations.Actor: properties: id: type: string readOnly: true name: type: string readOnly: true icon: type: string readOnly: true type: object description: 'Connect Actor details. `id` -- id of the actor. `name` -- name of the actor. `icon` -- icon of the actor.' conversations.Conversation: properties: id: type: string readOnly: true instance_id: type: string maxLength: 30 topic: type: string maxLength: 100 type: type: string enum: - conversation - notes default: conversation status: type: string enum: - open - closed readOnly: true default: open events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true accounts: type: array items: $ref: '#/components/schemas/conversations.Account' creator: $ref: '#/components/schemas/conversations.Actor' created: type: string format: date-time readOnly: true type: object description: 'Represents *Conversation* object. `id` -- id of the conversation. `instance_id` -- id of the object linked to the conversation (i.e. Helpdesk case, Fulfillment request, etc.). `topic` -- topic of the conversation. `type` -- conversation type. Can be one of `conversation` or `notes`. `status` -- status of the conversation. Can be one of `open` or `closed`. `events` -- the information about who and when created and/or updated the conversation. `accounts` -- information about partners which are involved into the conversation. `actor` -- information about the user who created / initiated the conversation. `created` -- the information about when was the conversation created.' required: - instance_id - topic - accounts conversations.Message: properties: id: type: string readOnly: true conversation: type: string readOnly: true account: $ref: '#/components/schemas/conversations.Account' created: type: string format: date-time readOnly: true creator: $ref: '#/components/schemas/conversations.Actor' text: type: string type: type: string enum: - message - state_change - private default: message events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: 'Represents *Message* object. `id` -- id of the message. `conversation` -- id of the linked conversation. `account` -- information about partner who posted the message into the conversation. `created` -- the information about when was the message created. `creator` -- information about the user who posted the message. `text` -- actual message value. `type` -- message type. Can be one of `message` (message visible for all accounts involved), `state_change` (message which appears in UI as status change and not as the message in a thread from a user) or `private` (message visible only to users of the creator account and not to the other involved partner users). `events` -- the information about who and when created and/or updated the conversation.' required: - text custom.Account: properties: id: type: string name: type: string icon: type: string type: object required: - id - name - icon custom.AttributePrototype: properties: id: type: string maxLength: 32 scope: type: string maxLength: 32 attribute: $ref: '#/components/schemas/custom.AttributePrototypeAttribute' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - id - scope - attribute custom.AttributePrototypeAttribute: properties: id: type: string maxLength: 64 name: type: string maxLength: 256 type: type: string maxLength: 64 hint: type: string maxLength: 512 constraints: type: object type: object required: - id - name - type - hint - constraints custom.AttributePrototypeCreate: properties: scope: type: string enum: - item attribute: $ref: '#/components/schemas/custom._APAttributeEdit' type: object required: - scope - attribute custom.AttributePrototypeUpdate: properties: scope: type: string enum: - item attribute: $ref: '#/components/schemas/custom._APAttributeEdit' type: object custom.CustomAttribute: properties: data: type: object owner: $ref: '#/components/schemas/custom.Account' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - data custom.CustomAttributeHistory: properties: data: type: object owner: $ref: '#/components/schemas/custom.Account' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - data custom.CustomAttributeMetadataRestrictions: properties: owner: type: array items: {} type: object custom._APAttributeConstraintsChoicesEdit: properties: name: type: string maxLength: 256 value: type: string maxLength: 256 type: object required: - name - value custom._APAttributeConstraintsEdit: properties: choices: type: array items: $ref: '#/components/schemas/custom._APAttributeConstraintsChoicesEdit' shared: type: string enum: - view nullable: true type: object custom._APAttributeEdit: properties: id: type: string maxLength: 64 name: type: string nullable: true maxLength: 256 type: type: string enum: - text - dropdown hint: type: string nullable: true maxLength: 512 constraints: $ref: '#/components/schemas/custom._APAttributeConstraintsEdit' type: object required: - id - type dp.AccountReference: properties: id: type: string name: type: string readOnly: true icon: type: string readOnly: true nullable: true type: object required: - id dp.ActivationField: properties: code: type: string readOnly: true maxLength: 100 message: type: string maxLength: 200 note: type: string maxLength: 100 type: object required: - message dp.ActorReference: properties: id: type: string readOnly: true name: type: string readOnly: true icon: type: string readOnly: true type: object dp.Agreement: properties: id: type: string readOnly: true type: type: string enum: - distribution - program - service - syndication - referral title: type: string maxLength: 100 name: type: string maxLength: 100 description: type: string events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true created: type: string format: date-time readOnly: true updated: type: string format: date-time readOnly: true owner: $ref: '#/components/schemas/dp.AccountReference' stats: type: object properties: contracts: type: integer versions: type: integer readOnly: true document_type: type: string enum: - external - uploaded - none default: external link: type: string format: uri writeOnly: true maxLength: 200 file: type: string format: binary writeOnly: true nullable: true active: type: boolean writeOnly: true parent: $ref: '#/components/schemas/dp.AgreementReference' marketplace: $ref: '#/components/schemas/dp.MarketplaceReference' version: $ref: '#/components/schemas/dp.AgreementVersionReference' forms: $ref: '#/components/schemas/dp.AgreementFormsReference' auto_accept: type: boolean sourcing_agreement: $ref: '#/components/schemas/dp.AgreementReference' type: object required: - name - description - marketplace dp.AgreementChild: properties: id: type: string readOnly: true type: type: string enum: - distribution - program - service - syndication - referral title: type: string maxLength: 100 name: type: string maxLength: 100 description: type: string events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true created: type: string format: date-time readOnly: true updated: type: string format: date-time readOnly: true owner: $ref: '#/components/schemas/dp.AccountReference' stats: type: object properties: contracts: type: integer versions: type: integer readOnly: true document_type: type: string enum: - external - uploaded - none default: external link: type: string format: uri writeOnly: true maxLength: 200 file: type: string format: binary writeOnly: true nullable: true active: type: boolean writeOnly: true parent: $ref: '#/components/schemas/dp.AgreementReference' marketplace: $ref: '#/components/schemas/dp.MarketplaceReference' version: $ref: '#/components/schemas/dp.AgreementVersionReference' forms: $ref: '#/components/schemas/dp.AgreementFormsReference' auto_accept: type: boolean sourcing_agreement: $ref: '#/components/schemas/dp.AgreementReference' type: object required: - name - description - marketplace dp.AgreementForm: properties: id: type: string readOnly: true version: type: integer readOnly: true name: type: string maxLength: 255 type: type: string enum: - enroll - product - item status: type: string readOnly: true schema: type: object events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - name - schema dp.AgreementFormReference: properties: id: type: string type: type: string enum: - enroll - product - item type: object required: - id dp.AgreementFormVersion: properties: id: type: string readOnly: true version: type: integer readOnly: true name: type: string maxLength: 255 type: type: string enum: - enroll - product - item status: type: string readOnly: true schema: type: object events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - name - schema dp.AgreementFormVersionReference: properties: id: type: string type: object required: - id dp.AgreementFormsReference: properties: enroll: $ref: '#/components/schemas/dp.AgreementFormReference' nullable: true product: $ref: '#/components/schemas/dp.AgreementFormReference' nullable: true item: $ref: '#/components/schemas/dp.AgreementFormReference' nullable: true type: object dp.AgreementReference: properties: id: type: string name: type: string readOnly: true type: object required: - id dp.AgreementReferenceWithDescription: properties: id: type: string name: type: string readOnly: true description: type: string type: object required: - id - description dp.AgreementVersion: properties: agreement: $ref: '#/components/schemas/dp.AgreementChild' readOnly: true author: $ref: '#/components/schemas/dp.ActorReference' version: type: integer readOnly: true active: type: boolean link: type: string readOnly: true version_created: type: string format: date-time readOnly: true version_contracts: type: integer readOnly: true type: object dp.AgreementVersionCreate: properties: document_type: type: string enum: - external - uploaded - none link: type: string format: uri nullable: true maxLength: 200 file: type: string format: binary nullable: true active: type: boolean type: object required: - document_type dp.AgreementVersionReference: properties: author: $ref: '#/components/schemas/dp.ActorReference' version: type: integer readOnly: true active: type: boolean link: type: string readOnly: true version_created: type: string format: date-time readOnly: true version_contracts: type: integer readOnly: true type: object dp.ApplicationUI: properties: description: type: string maxLength: 255 getting_started: type: string maxLength: 4096 download_links: type: array items: $ref: '#/components/schemas/dp.DownloadLink' documents: type: array items: $ref: '#/components/schemas/dp.Document' languages: type: array items: $ref: '#/components/schemas/dp.UILocale' provisioning_message: type: string type: object dp.AssetChangeRequest: type: object properties: type: type: string enum: - change asset: type: object properties: id: type: string items: type: array items: type: object properties: id: type: string quantity: type: number dp.AssetPurchaseRequest: type: object properties: type: type: string enum: - purchase note: type: string reason: type: string status: type: string enum: - draft - tiers_setup - pending - inquiring - approved - failed asset: type: object properties: external_id: type: string external_uid: type: string connection: type: object properties: id: type: string items: type: array items: type: object properties: id: type: string quantity: type: number readOnly: true 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 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 readOnly: true dp.AssetSuspendResumeCancelRequest: type: object properties: type: type: string enum: - suspend - resume - cancel asset: type: object properties: id: type: string dp.Cart: properties: validation: type: boolean type: object dp.Category: properties: id: type: string readOnly: true name: type: string maxLength: 255 parent: $ref: '#/components/schemas/dp.CategoryReference' readOnly: true children: type: array items: $ref: '#/components/schemas/dp.CategoryReference' readOnly: true family: $ref: '#/components/schemas/dp.FamilyReference' type: object required: - name - family dp.CategoryReference: properties: id: type: string readOnly: true name: type: string maxLength: 255 type: object required: - name dp.ConfigurationDataRead: properties: value: type: string nullable: true maxLength: 2000 structured_value: type: object parameter: $ref: '#/components/schemas/dp.Parameter' readOnly: true item: type: object properties: id: type: string name: type: string readOnly: true marketplace: $ref: '#/components/schemas/dp.MarketplaceReference' readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - structured_value dp.ConfigurationDataWrite: properties: value: type: string nullable: true maxLength: 2000 structured_value: type: object nullable: true parameter: $ref: '#/components/schemas/dp.Id' item: $ref: '#/components/schemas/dp.Id' marketplace: $ref: '#/components/schemas/dp.Id' type: object required: - parameter dp.Connection: properties: id: type: string readOnly: true type: type: string enum: - test - production status: type: string enum: - pending - approved - rejected - revoked - active readOnly: true provider: $ref: '#/components/schemas/dp.AccountReference' vendor: $ref: '#/components/schemas/dp.AccountReference' hub: $ref: '#/components/schemas/dp.HubConnection' created_at: type: string format: date-time readOnly: true endpoint_url: type: string readOnly: true frontend_url: type: string readOnly: true oauth_key: type: string readOnly: true oauth_secret: type: string readOnly: true version: type: string readOnly: true note: type: string nullable: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true product_version_type: type: string default: public type: object required: - provider - vendor - hub dp.ConnectionBase: properties: id: type: string readOnly: true type: type: string enum: - test - production status: type: string enum: - pending - approved - rejected - revoked - active provider: $ref: '#/components/schemas/dp.AccountReference' vendor: $ref: '#/components/schemas/dp.AccountReference' hub: $ref: '#/components/schemas/dp.HubReference' created_at: type: string format: date-time readOnly: true product_version_type: type: string enum: - public - staging type: object required: - provider - vendor - hub dp.ConnectionCreateTierConfigReference: properties: id: type: string type: type: string enum: - test - production status: type: string enum: - pending - approved - rejected - revoked - active readOnly: true provider: $ref: '#/components/schemas/dp.AccountReference' vendor: $ref: '#/components/schemas/dp.AccountReference' hub: $ref: '#/components/schemas/dp.HubReference' created_at: type: string format: date-time readOnly: true product_version_type: type: string enum: - public - staging type: object required: - provider - vendor - hub dp.ConnectionProductReference: properties: id: type: string readOnly: true name: type: string readOnly: true maxLength: 255 icon: type: string format: binary readOnly: true short_description: type: string readOnly: true version: type: integer readOnly: true type: object dp.ConnectionReference: properties: id: type: string readOnly: true type: type: string enum: - test - production status: type: string enum: - pending - approved - rejected - revoked - active provider: $ref: '#/components/schemas/dp.AccountReference' vendor: $ref: '#/components/schemas/dp.AccountReference' created_at: type: string format: date-time readOnly: true product: $ref: '#/components/schemas/dp.ConnectionProductReference' type: object required: - provider - vendor - product dp.Contract: properties: id: type: string readOnly: true type: type: string readOnly: true version: type: integer readOnly: true nullable: true status: type: string readOnly: true owner: $ref: '#/components/schemas/dp.AccountReference' version_created: type: string format: date-time readOnly: true nullable: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string signed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string countersigned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true name: type: string readOnly: true agreement: $ref: '#/components/schemas/dp.AgreementReference' creator: $ref: '#/components/schemas/dp.AccountReference' enrolled: type: string format: date-time readOnly: true nullable: true latest: type: string readOnly: true activation: $ref: '#/components/schemas/dp.ActivationField' signee: $ref: '#/components/schemas/dp.UserReference' kind: type: string enum: - production - test expire_at: type: string format: date-time nullable: true note: type: string nullable: true maxLength: 100 permissions: type: object writeOnly: true nullable: true termination_note: type: string nullable: true maxLength: 100 issuer: $ref: '#/components/schemas/dp.AccountReference' type: object dp.ContractNameAndMarketplaceReference: properties: id: type: string readOnly: true type: type: string readOnly: true name: type: string readOnly: true type: object dp.ContractNameReference: properties: id: type: string readOnly: true type: type: string readOnly: true name: type: string readOnly: true type: object dp.ContractReference: properties: id: type: string readOnly: true name: type: string readOnly: true type: type: string readOnly: true type: object dp.ContractVersion: properties: contract: $ref: '#/components/schemas/dp.Contract' readOnly: true version: type: string readOnly: true signee: $ref: '#/components/schemas/dp.UserReference' version_created: type: string format: date-time readOnly: true type: object dp.Country: properties: id: type: string name: type: string readOnly: true icon: type: string format: binary readOnly: true prefix: type: string readOnly: true type: object required: - id dp.CountryReference: properties: id: type: string name: type: string readOnly: true type: object required: - id dp.DistributionData: properties: id: type: string readOnly: true type: type: string readOnly: true created: type: string format: date-time readOnly: true contract: $ref: '#/components/schemas/dp.ContractReference' product: $ref: '#/components/schemas/dp.Product' item: $ref: '#/components/schemas/dp.ItemReferenceWithType' data: type: object form_version: $ref: '#/components/schemas/dp.AgreementFormVersionReference' type: object required: - data dp.Document: properties: title: type: string maxLength: 64 url: type: string format: uri maxLength: 1024 type: object required: - title - url dp.DownloadLink: properties: title: type: string maxLength: 64 url: type: string format: uri maxLength: 1024 visible_for: type: string enum: - admin - user default: admin type: object required: - title - url dp.EnabledField: properties: enabled: type: boolean type: object dp.FamilyReference: properties: id: type: string readOnly: true name: type: string maxLength: 255 type: object required: - name dp.Hub: properties: id: type: string readOnly: true name: type: string maxLength: 256 description: type: string company: $ref: '#/components/schemas/dp.AccountReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true stats: type: object properties: connections: type: integer marketplaces: type: integer readOnly: true instance: type: object properties: id: type: string type: type: string enum: - OA - API readOnly: true instance_id: type: string writeOnly: true nullable: true maxLength: 255 instance_type: type: string enum: - oa - api writeOnly: true version: type: string maxLength: 256 extension_version: type: string maxLength: 256 last_health_check: type: string format: date-time nullable: true type: object required: - name - description - instance_id - instance_type dp.HubConnection: properties: id: type: string readOnly: true name: type: string maxLength: 256 instance: type: object properties: id: type: string type: type: string enum: - OA - API readOnly: true type: object dp.HubReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 type: object dp.HubReferenceMarketplace: properties: id: type: string name: type: string readOnly: true icon: type: string format: binary readOnly: true description: type: string nullable: true external_id: type: string type: object required: - id - external_id dp.Id: properties: id: type: string type: object required: - id dp.IdWrite: properties: id: type: string writeOnly: true type: object required: - id dp.Inquiring: properties: validation: type: boolean type: object dp.ItemCommitment: properties: count: type: integer type: object required: - count dp.ItemCreate: properties: id: type: string readOnly: true name: type: string maxLength: 255 external_id: type: string nullable: true maxLength: 128 mpn: type: string description: type: string type: type: string enum: - Reservation - PPU dynamic: type: boolean item_type: type: string period: type: string enum: - Monthly - Yearly - years_2 - years_3 - years_4 - years_5 - years_6 - OneTime - days_7_trial - days_14_trial - days_30_trial - monthly_trial commitment: $ref: '#/components/schemas/dp.ItemCommitment' unit: $ref: '#/components/schemas/dp.ItemUnit' precision: type: string enum: - Integer - Decimal(1) - Decimal(2) - Decimal(4) - Decimal(8) product_version: type: integer created_by: type: string nullable: true group: $ref: '#/components/schemas/dp.ItemGroup' applicability: type: string enum: - cb - im nullable: true ui: $ref: '#/components/schemas/dp.ItemVisibility' type: object required: - name - mpn - description - type - unit - product_version dp.ItemGroup: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 255 mpn: type: string maxLength: 768 type: object required: - mpn dp.ItemReferenceWithStatus: properties: id: type: string readOnly: true name: type: string readOnly: true status: type: string enum: - draft - published - endofsale type: object dp.ItemReferenceWithType: properties: id: type: string readOnly: true name: type: string readOnly: true type: type: string enum: - COUNTER - SUBSCRIPTION_SERVICE type: object required: - type dp.ItemUnit: properties: id: type: string type: object required: - id dp.ItemUpdate: properties: ui: $ref: '#/components/schemas/dp.ItemVisibility' unit: $ref: '#/components/schemas/dp.ItemUnit' external_id: type: string nullable: true maxLength: 128 period: type: string enum: - Monthly - Yearly - years_2 - years_3 - years_4 - years_5 - years_6 - OneTime - days_7_trial - days_14_trial - days_30_trial - monthly_trial description: type: string mpn: type: string type: type: string enum: - Reservation - PPU precision: type: string enum: - Integer - Decimal(1) - Decimal(2) - Decimal(4) - Decimal(8) name: type: string maxLength: 255 commitment: $ref: '#/components/schemas/dp.ItemCommitment' dynamic: type: boolean gravity: type: object writeOnly: true group: $ref: '#/components/schemas/dp.ItemGroup' type: object dp.ItemVisibility: properties: visibility: type: boolean type: object required: - visibility dp.ListCategory: properties: id: type: string readOnly: true name: type: string maxLength: 255 parent: $ref: '#/components/schemas/dp.CategoryReference' children: type: array items: $ref: '#/components/schemas/dp.CategoryReference' readOnly: true family: $ref: '#/components/schemas/dp.FamilyReference' type: object required: - name - parent - family dp.Listing: properties: id: type: string readOnly: true status: type: string readOnly: true contract: $ref: '#/components/schemas/dp.ContractNameAndMarketplaceReference' product: $ref: '#/components/schemas/dp.Product' created: type: string format: date-time readOnly: true updated: type: string format: date-time readOnly: true vendor: $ref: '#/components/schemas/dp.AccountReference' provider: $ref: '#/components/schemas/dp.AccountReference' pending_request: $ref: '#/components/schemas/dp.ListingRequestReference' readOnly: true offer: $ref: '#/components/schemas/dp.Offer' pricelist: $ref: '#/components/schemas/dp.PriceList' alt_pricelist_1: $ref: '#/components/schemas/dp.PriceList' alt_pricelist_2: $ref: '#/components/schemas/dp.PriceList' type: object required: - offer - pricelist - alt_pricelist_1 - alt_pricelist_2 dp.ListingRequest: properties: id: type: string readOnly: true type: type: string enum: - new - remove state: type: string enum: - draft - reviewing - deploying - canceled - completed readOnly: true product: $ref: '#/components/schemas/dp.Product' readOnly: true listing: $ref: '#/components/schemas/dp.Listing' offer: $ref: '#/components/schemas/dp.Offer' pricelist: $ref: '#/components/schemas/dp.PriceList' alt_pricelist_1: $ref: '#/components/schemas/dp.PriceList' alt_pricelist_2: $ref: '#/components/schemas/dp.PriceList' creator: $ref: '#/components/schemas/dp.ActorReference' assignee: $ref: '#/components/schemas/dp.UserReference' created: type: string format: date-time readOnly: true updated: type: string format: date-time readOnly: true product_id: type: string writeOnly: true contract_id: type: string writeOnly: true listing_id: type: string writeOnly: true offer_id: type: string writeOnly: true nullable: true pricelist_id: type: string writeOnly: true nullable: true alt_pricelist_1_id: type: string writeOnly: true nullable: true alt_pricelist_2_id: type: string writeOnly: true nullable: true note: type: string writeOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - type dp.ListingRequestReference: properties: id: type: string readOnly: true type: type: string enum: - new - remove status: type: string type: object required: - type - status dp.LocaleReference: properties: id: type: string readOnly: true name: type: string maxLength: 128 type: object dp.Marketplace: properties: id: type: string readOnly: true name: type: string maxLength: 255 description: type: string nullable: true owner: $ref: '#/components/schemas/dp.AccountReference' icon: type: string format: binary readOnly: true zone: type: string enum: - AF - NA - OC - AS - EU - SA nullable: true hubs: type: array items: $ref: '#/components/schemas/dp.MarketplaceHub' active_contracts: type: integer readOnly: true countries: type: array items: $ref: '#/components/schemas/dp.CountryReference' currency: 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 nullable: true alt_currency_1: 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 nullable: true alt_currency_2: 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 nullable: true capabilities: $ref: '#/components/schemas/dp._MPCapabilities' attributes: type: object stats: $ref: '#/components/schemas/dp.MarketplaceStats' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true locales: type: array items: $ref: '#/components/schemas/dp.LocaleReference' type: object required: - name dp.MarketplaceExtendedReference: properties: id: type: string name: type: string readOnly: true description: type: string readOnly: true nullable: true countries: type: array items: $ref: '#/components/schemas/dp.CountryReference' currency: 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 readOnly: true nullable: true icon: type: string format: binary readOnly: true stats: $ref: '#/components/schemas/dp.MarketplaceStats' type: object required: - id dp.MarketplaceHub: properties: hub: $ref: '#/components/schemas/dp.HubReference' external_id: type: string maxLength: 255 type: object required: - hub - external_id dp.MarketplaceIcon: properties: icon: type: string format: binary writeOnly: true type: object required: - icon dp.MarketplaceReference: properties: id: type: string name: type: string readOnly: true icon: type: string format: binary readOnly: true type: object required: - id dp.MarketplaceStats: properties: hubs: type: integer readOnly: true contracts: type: integer readOnly: true type: object dp.Offer: properties: id: type: string nullable: true name: type: string maxLength: 512 plans: type: array items: $ref: '#/components/schemas/dp.Id' type: type: string enum: - generic - commerce readOnly: true nullable: true type: object required: - id dp.ParamChoice: properties: label: type: string value: type: string default: type: boolean type: object required: - label - value dp.ParamChoicesCreateReference: properties: choices: type: array items: $ref: '#/components/schemas/dp.ParamChoice' type: object dp.ParamPresentationCreateReference: properties: hidden: type: boolean readonly: type: boolean required: type: boolean meta: $ref: '#/components/schemas/dp.ParamChoicesCreateReference' choices: type: array items: $ref: '#/components/schemas/dp.ParamChoice' type: object dp.Parameter: properties: id: type: string readOnly: true name: type: string maxLength: 100 title: type: string maxLength: 255 description: type: string nullable: true type: type: string enum: - text - dropdown - password - email - checkbox - subdomain - domain - address - phone - object - url - choice - heading - content scope: type: string enum: - asset - tier1 - tier2 - product - item - marketplace - item_marketplace phase: type: string enum: - configuration - fulfillment - ordering hint: type: string default: type: object placeholder: type: string constraints: type: object properties: required: type: boolean hidden: type: boolean unique: type: boolean shared: type: string reconciliation: type: boolean min_length: type: integer max_length: type: integer choices: type: array items: type: string level: type: string display_content: type: string dependency: type: object properties: parameter: type: object properties: id: type: string name: type: string oneOf: - required: - id - required: - name values: type: array items: type: string required: type: boolean hidden: type: boolean readonly: type: boolean readOnly: true parent: $ref: '#/components/schemas/dp.ParameterReference' nullable: true type: object required: - name - title dp.ParameterCreate: properties: name: type: string maxLength: 100 title: type: string maxLength: 255 description: type: string nullable: true type: type: string enum: - text - dropdown - password - email - checkbox - subdomain - domain - address - phone - object - url - choice - heading - content scope: type: string phase: type: string constraints: type: object hint: type: string default: type: object placeholder: type: string parent: $ref: '#/components/schemas/dp.ParameterUpdateReference' nullable: true type: object required: - name - title - description - constraints dp.ParameterRead: properties: id: type: string name: type: string title: type: string maxLength: 255 description: type: string nullable: true type: type: string enum: - text - dropdown - password - email - checkbox - subdomain - domain - address - phone - object - url - choice - heading - content scope: type: string phase: type: string hint: type: string default: type: object placeholder: type: string constraints: type: object properties: required: type: boolean hidden: type: boolean unique: type: boolean shared: type: string reconciliation: type: boolean min_length: type: integer max_length: type: integer choices: type: array items: type: string level: type: string display_content: type: string dependency: type: object properties: parameter: type: object properties: id: type: string name: type: string oneOf: - required: - id - required: - name values: type: array items: type: string required: type: boolean hidden: type: boolean readonly: type: boolean readOnly: true parent: $ref: '#/components/schemas/dp.ParameterReference' nullable: true position: type: integer maximum: 4294967295 format: int64 nullable: true minimum: 0 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - id - name - title - scope - phase dp.ParameterReference: properties: id: type: string nullable: true maxLength: 128 name: type: string maxLength: 100 type: object required: - id dp.ParameterUpdate: properties: title: type: string description: type: string nullable: true type: type: string enum: - text - dropdown - password - email - checkbox - subdomain - domain - address - phone - object - url - choice - heading - content scope: type: string phase: type: string constraints: type: object hint: type: string default: type: object placeholder: type: string parent: $ref: '#/components/schemas/dp.ParameterUpdateReference' nullable: true type: object dp.ParameterUpdateReference: properties: id: type: string nullable: true maxLength: 128 name: type: string maxLength: 100 type: object required: - id dp.ParameterWrite: properties: id: type: string writeOnly: true value: type: string writeOnly: true nullable: true structured_value: type: object writeOnly: true nullable: true value_error: type: string writeOnly: true nullable: true structured_error: type: object writeOnly: true nullable: true constraints: $ref: '#/components/schemas/dp.ParamPresentationCreateReference' type: object required: - id dp.Partner: properties: id: type: string name: type: string status: type: string icon: type: string type: type: string role: type: string description: type: string overview: type: string headquarters: type: string countries: type: array items: {} languages: type: object websites: type: object stats: $ref: '#/components/schemas/dp.PartnerStats' contacts: type: array items: $ref: '#/components/schemas/dp.PartnerContact' readOnly: true industries: type: array items: $ref: '#/components/schemas/dp.PartnerIndustry' readOnly: true public: type: object type: object required: - id - name - status - icon - type - role - description - overview - headquarters - countries - languages - websites - stats - public dp.PartnerContact: properties: id: type: string name: type: string email: type: string format: email icon: type: string tags: type: array items: $ref: '#/components/schemas/dp.PartnerContactTag' readOnly: true type: object required: - id - name - email - icon dp.PartnerContactTag: properties: id: type: string readOnly: true name: type: string maxLength: 32 type: object required: - name dp.PartnerContractReference: properties: id: type: string readOnly: true status: type: string enum: - new - enrolling - pending - active - terminated - rejected readOnly: true version: type: integer readOnly: true type: object dp.PartnerContractsStats: properties: distribution: type: integer program: type: integer service: type: integer syndication: type: integer type: object required: - distribution - program - service - syndication dp.PartnerIndustry: properties: id: type: string readOnly: true name: type: string maxLength: 255 type: object required: - name dp.PartnerReference: properties: id: type: string readOnly: true name: type: string readOnly: true icon: type: string format: binary readOnly: true role: type: string readOnly: true agreement: $ref: '#/components/schemas/dp.AgreementReference' contract: $ref: '#/components/schemas/dp.PartnerContractReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string signed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string countersigned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object dp.PartnerStats: properties: contracts: $ref: '#/components/schemas/dp.PartnerContractsStats' listings: type: integer type: object required: - contracts - listings dp.PayAsYouGo: properties: ppu: type: boolean writeOnly: true schema: type: string enum: - TR - CR - PR - QT dynamic: type: boolean predictive: type: boolean future: type: boolean late: type: boolean required_custom_fields: type: array items: type: string type: object required: - ppu dp.PendingRequestReferenceRQL: properties: id: type: string readOnly: true type: type: string enum: - purchase - cancel - change - suspend - resume - adjustment - renew - transfer status: type: string enum: - draft - tiers_setup - pending - inquiring - approved - failed - scheduled - revoking - revoked template: $ref: '#/components/schemas/dp.TemplateReference' type: object dp.Post: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 128 external_id: readOnly: true creator: $ref: '#/components/schemas/dp.AccountReference' status: type: string enum: - draft - published - deleted audience: type: string enum: - private - vendor - reseller - distributor - any anonymous: type: boolean nullable: true version: type: integer title: type: string subtitle: type: string content: type: string cover: $ref: '#/components/schemas/dp._Cover' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string drafted: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - creator - version - title - subtitle - content - cover dp.PostCreate: properties: name: type: string nullable: true maxLength: 128 external_id: type: string nullable: true maxLength: 128 audience: type: string enum: - private - vendor - reseller - distributor - any anonymous: type: boolean nullable: true title: type: string maxLength: 256 subtitle: type: string maxLength: 256 content: type: string cover: $ref: '#/components/schemas/dp._CoverWrite' type: object required: - audience - title dp.PostUpdate: properties: name: type: string nullable: true maxLength: 128 external_id: type: string nullable: true maxLength: 128 audience: type: string enum: - private - vendor - reseller - distributor - any anonymous: type: boolean nullable: true title: type: string maxLength: 256 subtitle: type: string maxLength: 256 content: type: string cover: $ref: '#/components/schemas/dp._CoverWrite' type: object dp.PostVersion: properties: id: type: string name: type: string external_id: type: string creator: $ref: '#/components/schemas/dp.AccountReference' status: type: string audience: type: string anonymous: type: boolean version: type: integer maximum: 4294967295 format: int64 minimum: 0 title: type: string maxLength: 256 subtitle: type: string nullable: true maxLength: 256 content: type: string nullable: true cover: $ref: '#/components/schemas/dp._Cover' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string drafted: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - id - name - external_id - creator - status - audience - anonymous - version - title - cover dp.PriceList: properties: id: type: string nullable: true name: type: string maxLength: 512 status: type: string enum: - draft - scheduled - active - terminated type: object required: - id - name - status dp.Product: properties: id: type: string icon: type: string format: binary readOnly: true name: type: string readOnly: true status: type: string readOnly: true category: $ref: '#/components/schemas/dp.CategoryReference' description: type: string readOnly: true type: object description: Product References representation. required: - id dp.ProductActions: properties: action: type: string maxLength: 100 name: type: string maxLength: 100 type: type: string scope: type: string description: type: string maxLength: 300 id: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true title: type: string type: object required: - action - name - type - scope - description dp.ProductCreate: properties: name: type: string maxLength: 255 external_id: type: string nullable: true maxLength: 128 translations: type: array items: $ref: '#/components/schemas/dp.TranslationWrite' purchase_model: type: string type: object required: - name dp.ProductGroup: properties: id: type: string readOnly: true name: type: string maxLength: 512 description: type: string nullable: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true stats: $ref: '#/components/schemas/dp.ProductGroupStats' owner: $ref: '#/components/schemas/dp.AccountReference' type: object description: Product Group representation. Accessible only by Distributor. required: - name dp.ProductGroupReference: properties: id: type: string name: type: string maxLength: 512 description: type: string nullable: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true stats: $ref: '#/components/schemas/dp.ProductGroupStats' type: object required: - id dp.ProductGroupStats: properties: contracts: type: integer maximum: 4294967295 format: int64 minimum: 0 agreements: type: integer maximum: 4294967295 format: int64 minimum: 0 products: type: integer maximum: 4294967295 format: int64 minimum: 0 type: object dp.ProductMasterVersionUpdate: properties: usage_rule: type: object name: type: string maxLength: 255 external_id: type: string nullable: true maxLength: 128 short_description: type: string detailed_description: type: string icon: type: string format: binary capabilities: $ref: '#/components/schemas/dp.VirtualCapabilities' customer_ui_settings: type: object type: object dp.ProductMessage: properties: id: type: string readOnly: true product: $ref: '#/components/schemas/dp.Product' external_id: type: string maxLength: 128 value: type: string maxLength: 2048 auto: type: boolean description: If automatically added on validation response type: object required: - external_id - value dp.ProductTemplates: properties: id: type: string readOnly: true title: type: string name: type: string maxLength: 255 body: type: string scope: type: string enum: - asset - tier1 - tier2 type: type: string enum: - inquire - fulfillment - pending nullable: true position: type: integer maximum: 4294967295 format: int64 nullable: true minimum: 0 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - name dp.ProductTemplatesUpdate: properties: name: type: string maxLength: 255 body: type: string type: object dp.ProductVersion: properties: id: type: string readOnly: true name: type: string readOnly: true maxLength: 255 external_id: type: string icon: type: string format: binary readOnly: true status: type: string readOnly: true replacement: $ref: '#/components/schemas/dp.ReplacementProduct' end_of_sale_notes: type: string readOnly: true short_description: type: string readOnly: true detailed_description: type: string readOnly: true configurations: type: object properties: suspend_resume_supported: type: boolean requires_reseller_information: type: boolean readOnly: true customer_ui_settings: $ref: '#/components/schemas/dp.ApplicationUI' readOnly: true version: type: integer readOnly: true published_at: type: string format: date-time readOnly: true nullable: true category: $ref: '#/components/schemas/dp.CategoryReference' owner: $ref: '#/components/schemas/dp.AccountReference' latest: type: boolean readOnly: true media: type: object properties: id: type: string type: type: string thumbnail: type: string url: type: string readOnly: true usage_rule: type: object properties: enabled: type: boolean providers: type: array items: type: object properties: id: type: string name: type: string readOnly: true stats: type: object properties: versions: type: integer readOnly: true capabilities: $ref: '#/components/schemas/dp.VirtualCapabilities' readOnly: true visibility: type: object properties: owner: type: boolean listing: type: boolean syndication: type: boolean catalog: type: boolean readOnly: true changes_description: type: string readOnly: true description: Change log for product version public: type: boolean readOnly: true description: Is version available for Providers staging: type: boolean readOnly: true description: Is version available for staging tests events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true extensions: type: object properties: id: type: string name: type: string status: type: string package_url: type: string readOnly: true purchase_model: type: string type: object required: - external_id - purchase_model dp.ProductVersionCreateUpdate: properties: changes_description: type: string writeOnly: true public: type: boolean writeOnly: true description: Is version available for Providers staging: type: boolean writeOnly: true description: Is version available for staging tests type: object description: Product version serializer for CREATE and UPDATE operations dp.ProductVersionMediaCreate: properties: position: type: integer maximum: 8 minimum: 1 type: type: string enum: - image - video thumbnail: type: string format: binary url: type: string format: uri type: object required: - position - type - thumbnail dp.ProductVersionMediaUpdate: properties: type: type: string enum: - image - video thumbnail: type: string format: binary url: type: string format: uri type: object dp.RegenerateSecret: properties: jwt_secret: type: string readOnly: true type: object description: Serializer class for regenerate secret key dp.ReplacementProduct: properties: id: type: string readOnly: true description: Product ID icon: type: string format: binary readOnly: true name: type: string readOnly: true status: type: string readOnly: true type: object dp.RequestReference: properties: id: type: string readOnly: true type: type: string enum: - purchase - cancel - change - suspend - resume - adjustment - renew - transfer status: type: string enum: - draft - tiers_setup - pending - inquiring - approved - failed - scheduled - revoking - revoked events: type: object properties: created: type: object properties: at: type: string format: datetime updated: type: object properties: at: type: string format: datetime readOnly: true assignee: type: object properties: id: type: string name: type: string readOnly: true type: object dp.Reservation: properties: consumption: type: boolean type: object dp.SLI: properties: zone: type: integer days: type: integer type: object required: - zone - days dp.Subscription: properties: id: type: string readOnly: true status: type: string enum: - draft - processing - active - terminating - suspended - terminated external_id: type: string nullable: true maxLength: 100 external_uid: type: string nullable: true maxLength: 100 product: $ref: '#/components/schemas/dp.Product' connection: $ref: '#/components/schemas/dp.ConnectionBase' 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 quantity: type: number readOnly: true params: type: array items: type: array items: type: object properties: id: type: string title: type: string description: type: string value: type: string value_error: type: string type: type: string enum: - text - dropdown - password - email - checkbox - subdomain - domain - phone - url - choice scope: type: string enum: - asset - tier1 - tier2 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 choices: type: array items: type: object properties: label: type: string value: type: string readOnly: true 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 readOnly: true template: $ref: '#/components/schemas/dp.TemplateReference' pending_request: $ref: '#/components/schemas/dp.PendingRequestReferenceRQL' marketplace: $ref: '#/components/schemas/dp.MarketplaceReference' contract: $ref: '#/components/schemas/dp.ContractNameReference' renewal_expiration_date: type: string format: date-time nullable: 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 type: object required: - external_id - external_uid - product - connection - params - marketplace - contract dp.SubscriptionCancel: properties: scheduling: type: boolean offline: type: string enum: - 'no' - auto - allowed type: object dp.SubscriptionChange: properties: editable_ordering_parameters: type: boolean validation: type: boolean inquiring_validation: type: boolean scheduling: type: boolean simultaneous_adjustment: type: boolean editable_fulfillment_parameters: type: boolean type: object dp.SubscriptionParameter: properties: versions: type: boolean type: object dp.SubscriptionPurchase: properties: scheduling: type: boolean type: object dp.SubscriptionRenew: properties: enable_renew: type: boolean editable_ordering_parameters: type: boolean editable_fulfillment_parameters: type: boolean validation: type: boolean inquiring_validation: type: boolean scheduling: type: boolean type: object dp.SubscriptionResume: properties: scheduling: type: boolean type: object dp.SubscriptionSuspend: properties: scheduling: type: boolean offline: type: string enum: - 'no' - auto - allowed type: object dp.SubscriptionTransfer: properties: enable_transfer: type: boolean transfer_autoapprove: type: boolean editable_ordering_parameters: type: boolean editable_fulfillment_parameters: type: boolean validation: type: boolean inquiring_validation: type: boolean type: object dp.TemplateReference: properties: id: type: string readOnly: true name: type: string type: object required: - name dp.TierAccountBulkReference: properties: id: type: string writeOnly: true index: type: integer writeOnly: true type: object dp.TierAccountCreate: properties: type: type: string enum: - customer - reseller external_uid: type: string nullable: true maxLength: 255 external_id: type: string nullable: true maxLength: 255 parent: $ref: '#/components/schemas/dp.TierAccountBulkReference' name: type: string maxLength: 255 hub: $ref: '#/components/schemas/dp.IdWrite' contact_info: $ref: '#/components/schemas/dp.TierContactInfoReference' tax_id: type: string nullable: true maxLength: 100 access: type: array items: $ref: '#/components/schemas/dp.IdWrite' environment: type: string enum: - production - test - preview nullable: true type: object required: - contact_info dp.TierAccountDetail: properties: id: type: string readOnly: true version: type: integer readOnly: true name: type: string type: type: string enum: - customer - reseller db: type: string enum: - EU - US - JP - AU external_id: type: string nullable: true maxLength: 255 external_uid: type: string maxLength: 255 parent: $ref: '#/components/schemas/dp.TierAccountReference' owner: $ref: '#/components/schemas/dp.AccountReference' scopes: type: array items: type: string readOnly: true hub: $ref: '#/components/schemas/dp.HubReference' readOnly: true tax_id: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string decommissioned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true environment: type: string enum: - production - test - preview nullable: true 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 type: object required: - name - db - external_uid - parent - owner dp.TierAccountReference: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 255 external_id: type: string nullable: true maxLength: 255 type: object dp.TierAccountRequest: properties: id: type: string readOnly: true type: type: string enum: - update status: type: string enum: - pending - accepted - ignored - unsupported account: $ref: '#/components/schemas/dp.TierAccountVersion' readOnly: true vendor: $ref: '#/components/schemas/dp.AccountReference' readOnly: true provider: $ref: '#/components/schemas/dp.AccountReference' product: $ref: '#/components/schemas/dp.Product' reason: type: string nullable: true maxLength: 255 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - type - status dp.TierAccountRequestCreate: properties: type: type: string enum: - update type: object required: - type dp.TierAccountUpdate: properties: type: type: string enum: - customer - reseller external_uid: type: string maxLength: 255 external_id: type: string maxLength: 255 parent: $ref: '#/components/schemas/dp.TierAccountBulkReference' name: type: string maxLength: 255 contact_info: $ref: '#/components/schemas/dp.TierContactInfoReference' tax_id: type: string nullable: true maxLength: 100 access: type: array items: $ref: '#/components/schemas/dp.IdWrite' environment: type: string enum: - production - test - preview nullable: true type: object dp.TierAccountVersion: properties: id: type: string version: type: integer db: type: string readOnly: true name: type: string type: type: string external_id: type: string external_uid: type: string readOnly: true parent: $ref: '#/components/schemas/dp.TierAccountReference' readOnly: true owner: $ref: '#/components/schemas/dp.AccountReference' readOnly: true scopes: type: array items: type: string readOnly: true hub: $ref: '#/components/schemas/dp.HubReference' readOnly: true 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 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string decommissioned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true environment: type: string enum: - production - test - preview readOnly: true type: object required: - id - version - name - type - external_id - tax_id dp.TierConfigRequestCreate: properties: configuration: $ref: '#/components/schemas/dp.TierConfigurationCreate' status: type: string enum: - tiers_setup - pending - inquiring - approved - failed - draft params: type: array items: $ref: '#/components/schemas/dp.ParameterWrite' maxItems: 50 minItems: 0 type: type: string enum: - setup - update - adjustment notes: type: string nullable: true maxLength: 2000 type: object required: - configuration dp.TierConfigRequestRead: properties: id: type: string readOnly: true type: type: string enum: - setup - update - adjustment status: type: string enum: - tiers_setup - pending - inquiring - approved - failed - draft configuration: $ref: '#/components/schemas/dp.TierConfiguration' parent_configuration: $ref: '#/components/schemas/dp.TierConfiguration' previous_approved_request: $ref: '#/components/schemas/dp.TierConfigRequestReference' params: type: string readOnly: true assignee: $ref: '#/components/schemas/dp.ActorReference' template: $ref: '#/components/schemas/dp.TemplateReference' reason: type: string nullable: true maxLength: 500 activation: type: object properties: link: type: string readOnly: true notes: type: string nullable: true environment: type: string readOnly: true effective_date: type: string format: date-time readOnly: true nullable: true tiers: type: object properties: 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 readOnly: true sli: $ref: '#/components/schemas/dp.SLI' 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 inquired: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string pended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string readOnly: true type: object required: - type - configuration - parent_configuration - assignee - template - sli dp.TierConfigRequestReference: properties: id: type: string readOnly: true type: object dp.TierConfiguration: properties: id: type: string readOnly: true name: type: string readOnly: true account: 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 product: $ref: '#/components/schemas/dp.Product' tier_level: type: string enum: - 1 - 2 minimum: -2147483648 maximum: 2147483647 connection: $ref: '#/components/schemas/dp.ConnectionCreateTierConfigReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true params: type: array items: type: object properties: id: type: string title: type: string description: type: string value: type: string value_error: type: string type: type: string enum: - text - dropdown - password - email - checkbox - subdomain - domain - phone - url - choice scope: type: string enum: - asset - tier1 - tier2 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 choices: type: array items: type: object properties: label: type: string value: type: string readOnly: true template: $ref: '#/components/schemas/dp.TemplateReference' open_request: $ref: '#/components/schemas/dp.TierConfigRequestReference' status: type: string enum: - active - processing 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 contract: $ref: '#/components/schemas/dp.ContractReference' marketplace: $ref: '#/components/schemas/dp.MarketplaceReference' type: object required: - product - tier_level dp.TierConfigurationCreate: properties: id: type: string readOnly: true type: object required: - id dp.TierConfigurationDetail: properties: id: type: string readOnly: true name: type: string readOnly: true account: 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 product: $ref: '#/components/schemas/dp.Product' tier_level: type: string enum: - 1 - 2 minimum: -2147483648 maximum: 2147483647 connection: $ref: '#/components/schemas/dp.ConnectionCreateTierConfigReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true params: type: array items: type: object properties: id: type: string title: type: string description: type: string value: type: string value_error: type: string type: type: string enum: - text - dropdown - password - email - checkbox - subdomain - domain - phone - url - choice scope: type: string enum: - asset - tier1 - tier2 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 choices: type: array items: type: object properties: label: type: string value: type: string readOnly: true template: $ref: '#/components/schemas/dp.TemplateReference' open_request: $ref: '#/components/schemas/dp.TierConfigRequestReference' status: type: string enum: - active - processing 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 contract: $ref: '#/components/schemas/dp.ContractReference' marketplace: $ref: '#/components/schemas/dp.MarketplaceReference' tiers: type: string readOnly: true type: object required: - product - tier_level dp.TierContactInfoContactPhoneNumberReference: properties: country_code: type: string nullable: true maxLength: 25 area_code: type: string nullable: true maxLength: 25 phone_number: type: string nullable: true maxLength: 25 extension: type: string nullable: true maxLength: 25 type: object required: - country_code - phone_number dp.TierContactInfoContactReference: properties: first_name: type: string maxLength: 100 last_name: type: string maxLength: 100 email: type: string format: email maxLength: 254 phone_number: $ref: '#/components/schemas/dp.TierContactInfoContactPhoneNumberReference' type: object required: - first_name - last_name - email dp.TierContactInfoReference: properties: address_line1: type: string maxLength: 255 address_line2: type: string nullable: true maxLength: 255 city: type: string maxLength: 100 state: type: string nullable: true maxLength: 100 country: type: string maxLength: 100 postal_code: type: string maxLength: 50 contact: $ref: '#/components/schemas/dp.TierContactInfoContactReference' type: object required: - address_line1 - city - country - postal_code - contact dp.TierTemplateRead: properties: {} type: object dp.Tiers: properties: updates: type: boolean configs: $ref: '#/components/schemas/dp.TiersConfigs' validation: type: boolean type: object dp.TiersConfigs: properties: configs: type: boolean writeOnly: true level: type: string enum: - 1 - 2 setup: $ref: '#/components/schemas/dp.TiersConfigsSetup' update: $ref: '#/components/schemas/dp.TiersConfigsUpdate' type: object required: - configs dp.TiersConfigsSetup: properties: inquiring_validation: type: boolean type: object dp.TiersConfigsUpdate: properties: validation: type: boolean inquiring_validation: type: boolean type: object dp.TranslationWrite: properties: locale: $ref: '#/components/schemas/dp.IdWrite' description: type: string primary: type: boolean auto: $ref: '#/components/schemas/dp.EnabledField' type: object required: - locale dp.UIItem: properties: id: type: string readOnly: true name: type: string readOnly: true status: type: string enum: - draft - published - endofsale external_id: type: string unit: $ref: '#/components/schemas/dp.Unit' mpn: type: string nullable: true position: type: integer type: type: string readOnly: true local_id: type: string readOnly: true display_name: type: string maxLength: 255 period: type: string readOnly: true precision: type: string readOnly: true commitment: type: object properties: multiplier: type: string count: type: integer readOnly: true dynamic: type: boolean applicability: type: string enum: - cb - im nullable: true description: This value scopes applicability of the item to IM or CB partners exclusively. Empty value means Global availability. description: type: string readOnly: true parent: $ref: '#/components/schemas/dp.ItemReferenceWithStatus' depth: type: integer replacement: $ref: '#/components/schemas/dp.ItemReferenceWithStatus' end_of_sale_notes: type: string nullable: true group: $ref: '#/components/schemas/dp.ItemGroup' ui: $ref: '#/components/schemas/dp.UIVisibility' readOnly: true ui_visibility: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string saleended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - external_id - unit - display_name - parent - replacement - end_of_sale_notes - group dp.UILocale: properties: id: type: string name: type: string readOnly: true type: object required: - id dp.UIVisibility: properties: visibility: type: boolean readOnly: true type: object dp.Unit: properties: id: type: string maxLength: 64 name: type: string maxLength: 255 title: type: string maxLength: 255 unit: type: string maxLength: 64 type: object required: - id - name - title dp.UserReference: properties: id: type: string readOnly: true name: type: string readOnly: true nullable: true icon: type: string readOnly: true nullable: true type: object dp.VCSubscriptionSerializer: properties: cancel: $ref: '#/components/schemas/dp.SubscriptionCancel' change: $ref: '#/components/schemas/dp.SubscriptionChange' parameter: $ref: '#/components/schemas/dp.SubscriptionParameter' purchase: $ref: '#/components/schemas/dp.SubscriptionPurchase' resume: $ref: '#/components/schemas/dp.SubscriptionResume' suspend: $ref: '#/components/schemas/dp.SubscriptionSuspend' renew: $ref: '#/components/schemas/dp.SubscriptionRenew' transfer: $ref: '#/components/schemas/dp.SubscriptionTransfer' hold: type: boolean schema: type: string enum: - explicit - evergreen type: object dp.VirtualCapabilities: properties: ppu: $ref: '#/components/schemas/dp.PayAsYouGo' reservation: $ref: '#/components/schemas/dp.Reservation' cart: $ref: '#/components/schemas/dp.Cart' inquiring: $ref: '#/components/schemas/dp.Inquiring' tiers: $ref: '#/components/schemas/dp.Tiers' subscription: $ref: '#/components/schemas/dp.VCSubscriptionSerializer' type: object dp._Cover: properties: type: type: string enum: - image - video thumbnail: type: string url: readOnly: true type: object required: - type - thumbnail dp._CoverWrite: properties: type: type: string enum: - image - video thumbnail: type: string url: type: string format: uri nullable: true maxLength: 512 type: object required: - type - thumbnail dp._MPCapabilities: properties: listing: $ref: '#/components/schemas/dp._MPListingCapabilities' price_list: $ref: '#/components/schemas/dp._MPPriceListCapabilities' type: object dp._MPListingCapabilities: properties: referral_auto: type: boolean type: object dp._MPPriceListCapabilities: properties: commerce_compatibility: type: boolean type: object eaas.AccountReference: properties: id: type: string readOnly: true name: type: string maxLength: 64 icon: type: string nullable: true maxLength: 2000 role: type: string enum: - vendor - distributor - reseller type: object required: - name eaas.CatalogExtension: properties: id: type: string readOnly: true extension_id: type: string type: type: string enum: - products - hub - multiaccount - transformations name: type: string maxLength: 256 icon: type: string format: binary nullable: true owner: $ref: '#/components/schemas/eaas.AccountReference' catalog_status: type: string readOnly: true short_description: type: string readOnly: true category: type: string readOnly: true installed: type: boolean type: object description: 'Extension. Is used to represent an Extension for catalog of extension. `id` -- id of an extension. `type` -- type of an extension (products, hub or multiaccount). `name` -- name of an extension. `owner` -- Connect account who owns this extension. `environment` -- Environment. `catalog_status` -- catalog status of an extension in auth. `short_description` -- short description of an extension. `overview` -- overview of an extension. `category` -- category of an extension. `website` -- website for an extension. `installed` -- installation status of an extension for user. `installation` -- installation info of an extension for user. `icon` -- icon of an extension. `events` -- updated event.' required: - extension_id - name - installed eaas.CatalogRequest: properties: id: type: string readOnly: true type: type: string enum: - publish - unpublish extension: $ref: '#/components/schemas/eaas.ExtensionReference' status: type: string enum: - pending - cancelled - accepted - denied case: type: string nullable: true maxLength: 50 comment: type: string nullable: true maxLength: 4000 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: 'CatalogRequest. Is used to represent a concrete catalog request. `id` -- id of concrete catalog request. `type` -- type of concrete catalog request. `extension` -- related extension of concrete catalog request. `status` -- status of concrete catalog request. `case` -- helpdesk case id of concrete catalog request. `comment` -- comment of concrete catalog request. `events` -- created and updated events.' eaas.ContainerImage: properties: name: type: string nullable: true maxLength: 256 base_image: type: string maxLength: 256 repository_url: type: string maxLength: 256 repository_tag: type: string maxLength: 256 repository_commit: type: string maxLength: 64 repository_username: type: string nullable: true maxLength: 256 command: type: string maxLength: 256 type: object required: - base_image - repository_url - repository_tag - repository_commit - command eaas.Environment: properties: id: type: string type: type: string enum: - production - test - development readOnly: true runtime: type: string enum: - local - cloud external_id: type: string format: uuid readOnly: true git: $ref: '#/components/schemas/eaas.GitInfo' readme_url: type: string format: uri readOnly: true changelog_url: type: string format: uri readOnly: true schedulables: type: object nullable: true resources: $ref: '#/components/schemas/eaas.Resource' features: $ref: '#/components/schemas/eaas.Features' jwt_secret: type: string nullable: true maxLength: 512 status: type: string enum: - uninitialized - building - deploying - standby - running - upgrading - stopping - stopped - connected - disconnected - errored log_level: type: string enum: - DEBUG - INFO - WARNING - ERROR anvil_callables: type: object readOnly: true nullable: true hostname: type: string readOnly: true domain: type: string readOnly: true configuration: type: array items: $ref: '#/components/schemas/eaas.VariableReference' configuration_changed: type: boolean instances: type: array items: $ref: '#/components/schemas/eaas.InstanceReference' extension: $ref: '#/components/schemas/eaas.ExtensionReference' icon: type: string readOnly: true nullable: true ui_modules: type: string readOnly: true current_image: $ref: '#/components/schemas/eaas.ContainerImage' target_image: $ref: '#/components/schemas/eaas.ContainerImage' replicas: type: string readOnly: true type: object description: "Extension Environment.\n\nIs used to represent a concrete environment\ \ for the Extension.\n\n`id` -- unique environment id on Connect.\n`type`\ \ -- type of the environment: `Test`, `Development` or `Production`.\n`runtime`\ \ -- type of the runtime: `Local` or `Cloud`.\n`external_id` -- id of the\ \ environment in external system (i.e. Container ID on Azure).\n`status` --\ \ status of the environment. One of `Uninitialized`, `Deploying`, `Running`,\n\ `Stopping`, `Stopped`, `Uninitialized`, `Connected`, `Disconnected` or `Errored`.\n\ `git` -- in case if environment is of `Cloud` type, this property contains\ \ git details\n from where the extension code should be downloaded.\n`readme_url`\ \ -- local path on repository to README.md file.\n`changelog_url` -- local\ \ path on repository to CHANGELOG.md file.\n `configuration_changed` -- Flag\ \ that indicates that configuration\n has changed and need to be updated.\n\ \ `resources` -- hardware resources like cpu and memory.\n`configuration`\ \ -- specific configuration values.\n`jwt_secret` -- JWT token used for the\ \ authentication.\n`instances` -- instances associated to the given environment.\n\ `status` -- status of the environment. One of `Uninitialized`, `Deploying`,\ \ `Running`,\n `Stopping` or `Stopped`.\n `configuration_changed` -- Flag\ \ that indicates that configuration\n has changed and need to be updated.\n\ `ui_modules` -- JSON object of ui module configuration of concrete extension.\n\ `icon` -- icon of concrete environment for extension." required: - extension eaas.EnvironmentEvent: properties: id: type: string timestamp: type: string format: date-time severity: type: string environment: type: string message: type: string details: type: string type: object description: 'Environment Events. Is used to represent the last 10 events captured for this environment.' required: - id - timestamp - severity - environment - message - details eaas.EnvironmentLogs: properties: id: type: string type: type: string runtime: type: string logs: type: object type: object description: 'Logs. Is used to represent the logs captured for this environment.' required: - id - type - runtime - logs eaas.EnvironmentMetrics: properties: id: type: string type: type: string runtime: type: string instances: type: object type: object description: 'Environment Stats. Is used to represent the hardware resources consumed by each environment instance.' required: - id - type - runtime - instances eaas.EnvironmentReference: properties: id: type: string readOnly: true type: type: string enum: - production - test - development icon: type: string readOnly: true nullable: true extension: $ref: '#/components/schemas/eaas.ExtensionReference' ui_modules: type: string readOnly: true hostname: type: string domain: type: string git: $ref: '#/components/schemas/eaas.GitInfo' runtime: type: string type: object description: 'Environment. Is used to specify a concrete Environment. `id` -- the environment id. `type` -- the environment type: development, test or production. `icon` -- the environment icon.' required: - type - extension - hostname - domain - runtime eaas.EventDefinition: properties: id: type: integer readOnly: true source: type: string enum: - system - user type: type: string maxLength: 128 name: type: string maxLength: 128 description: type: string maxLength: 512 category: type: string enum: - background - interactive - scheduled - transformation group: type: string maxLength: 64 extension_type: type: string enum: - products - hub - multiaccount - transformations - multiaccount+products object_statuses: type: object type: object required: - type - name - description - category - group eaas.Extension: properties: id: type: string readOnly: true type: type: string enum: - products - hub - multiaccount - transformations name: type: string maxLength: 256 description: type: string nullable: true maxLength: 2048 icon: type: string format: binary nullable: true package_id: type: string nullable: true maxLength: 256 products: type: array items: $ref: '#/components/schemas/eaas.ProductReference' hub: $ref: '#/components/schemas/eaas.HubReference' extension_id: type: string readOnly: true owner: $ref: '#/components/schemas/eaas.AccountReference' environments: $ref: '#/components/schemas/eaas.ServiceEnvironments' catalog_status: type: string readOnly: true overview: type: string readOnly: true short_description: type: string readOnly: true website: type: string readOnly: true category: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true catalog_case_id: type: string readOnly: true type: object description: 'Extension. Is used to represent a concrete products, hub or multiaccount Extension. `id` -- id of concrete extension. `type` -- type of concrete extension (products, hub or multiaccount). `name` -- name of concrete extension. `description` -- description of concrete extension. `icon` -- icon of concrete extension. `products` -- Connect products this extension is linked to. `hub` -- Connect hub this extension is linked to. `owner` -- Connect account who owns this extension. `package_id` -- package id of of concret multiaccount extension. `events` -- created and updated events. `environments` -- list of environments assigned to this extension. `catalog_status` -- catalog status of concrete extension in auth. `extension_id` -- extension id in auth of concrete extension. `overview` -- overview of concrete extension. `short_description` -- short description of concrete extension. `website` -- website of concrete multiaccount extension. `category` -- category of concrete extension.' required: - name eaas.ExtensionForUIPageReference: properties: title: type: string icon: type: string format: binary hostname: type: string readOnly: true domain: type: string readOnly: true login_uri: type: string readOnly: true id: type: string extension_id: type: string readOnly: true type: object description: 'Environment Is used to represent a concrete UIPage. `title` -- title of concrete extension. `icon` -- icon of concrete extension. `hostname` -- hostname of concrete extension. `domain` -- domain of concrete extension. `login_uri` -- login_uri of concrete extension. `id` -- id of concrete extension. `extension_id` -- id of extension from auth module (EXT-000-000). `icon` -- icon of concrete extension.' required: - title - icon - id eaas.ExtensionReference: properties: id: type: string name: type: string readOnly: true owner: $ref: '#/components/schemas/eaas.AccountReference' icon: type: string format: binary nullable: true extension_id: type: string readOnly: true type: object required: - id eaas.Features: properties: event_processing_available: type: boolean custom_api_available: type: boolean web_app_available: type: string readOnly: true anvil_app_available: type: boolean transformation_app_available: type: boolean type: object eaas.GitCredentialsModel: properties: username: type: string nullable: true password: type: string nullable: true type: object description: 'Git Credentials. Is used to represent input object to request git tags. You need to provide `username` and `password` to your git repository as input data.' eaas.GitCredentialsTagsRequest: properties: username: type: string nullable: true password: type: string nullable: true type: object description: 'Git Credentials. Is used to represent input object to request git tags. You need to provide `username` and `password` to your git repository as input data.' eaas.GitInfo: properties: url: type: string format: uri tag: type: string commit: type: string auth: $ref: '#/components/schemas/eaas.GitCredentialsModel' type: object description: 'Git Info. Is used to represent git repository information `auth` -- object containing `username` and `password` to git repository if required. `url` -- repository URL. `tag` -- tag to be used. Connect will checkout the code according to this tag. `commit` -- commit to be used. Connect will checkout the code according to this commit.' required: - url - tag - commit eaas.GitTags: properties: url: type: string format: uri auth: $ref: '#/components/schemas/eaas.GitCredentialsTagsRequest' tags: type: array items: type: string type: object description: 'Git Tags. Is used to represent repository tags' required: - url eaas.GitTagsRequest: properties: url: type: string format: uri auth: $ref: '#/components/schemas/eaas.GitCredentialsTagsRequest' type: object description: 'Git Tags Request. Is used to represent input object to request git tags. You need to provide `url` and `auth` as input data.' required: - url eaas.GitUpdate: properties: auth: $ref: '#/components/schemas/eaas.GitCredentialsModel' url: type: string format: uri tag: type: string commit: type: string type: object description: 'Git repo update serializer. Is used to validate the git update request. `auth` -- authentication details to git repository. `url` -- URL of the git repository. `tag` -- exact tag to be checked out. `commit` -- exact commit to be checked out which matches the tag.' required: - url - tag eaas.HubReference: properties: id: type: string name: type: string readOnly: true type: object description: 'Hub. Is used to represent a concrete Hub linked to this Extension. `id` -- id of a concrete hub linked to this Extension. `name` -- name of a concrete hub linked to this Extension.' required: - id eaas.Installation: properties: id: type: string readOnly: true environment: $ref: '#/components/schemas/eaas.EnvironmentReference' owner: $ref: '#/components/schemas/eaas.AccountReference' settings: type: object events: type: object properties: installed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string uninstalled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true status: type: string enum: - installed - uninstalled comment: type: string nullable: true maxLength: 4000 type: object description: 'Installation. Is used to represent a concrete installation. `id` -- id of concrete installation. `environment` -- installation environment. `account` -- installation owner account. `settings` -- installation settings. `events` -- installed, uninstalled and updated events. `status` -- status of installation. `comment` -- reason of uninstall.' required: - environment - settings eaas.InstallationReference: properties: id: type: string readOnly: true owner: $ref: '#/components/schemas/eaas.AccountReference' status: type: string enum: - installed - uninstalled type: object eaas.Instance: properties: id: type: string readOnly: true error_output: type: string nullable: true type: object description: 'Instance. Is used to represent a concrete environment Instance. `id` -- id of concrete instance. `error_output` -- error output of concrete instance.' eaas.InstanceReference: properties: id: type: string readOnly: true container_id: type: string nullable: true maxLength: 64 runtime: type: string enum: - local - cloud status: type: string enum: - connected - disconnected - decommissioned events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string stopped: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string decommissioned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: 'Instances repository. Is used to represent the instances related to an Environment `id` -- Instance ID. `container_id` -- Azure Container ID. `runtime` -- Can be of `Local` or `Cloud`. `status` -- Can be of `Connected`, `Disconnected` or `Decommissioned`.' eaas.Invitation: properties: id: type: string readOnly: true title: type: string nullable: true maxLength: 256 code: type: string readOnly: true nullable: true environment: $ref: '#/components/schemas/eaas.EnvironmentReference' status: type: string enum: - invited - accepted - revoked readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string accepted: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true installation: $ref: '#/components/schemas/eaas.InstallationReference' type: object description: 'Invitation. Is used to represent a concrete installation Invitation. `id` -- id of concrete invitation. `title` -- title of concrete invitation. `code` -- installation code of concrete invitation. `environment` -- environment installation destination. `status` -- status of concrete invitation. `events` -- crated and updated events. `installation` -- invitation installation data.' required: - environment eaas.LogzAccountArchivingConfig: properties: setting_id: type: integer maximum: 2147483647 minimum: -2147483648 writeOnly: true nullable: true tenant_id: type: string nullable: true maxLength: 64 client_id: type: string nullable: true maxLength: 64 client_secret: type: string nullable: true maxLength: 512 storage_account: type: string nullable: true maxLength: 256 container: type: string nullable: true maxLength: 256 type: object description: 'LogzAccount archiving config. Is used to represent the LogzAccount archiving config.' eaas.ProductReference: properties: id: type: string name: type: string readOnly: true icon: type: string readOnly: true nullable: true type: object description: 'Product. Is used to represent a concrete Product linked to this Extension. `id` -- id of a concrete product linked to this Extension. `name` -- name of a concrete product linked to this Extension.' required: - id eaas.RepositoryTags: properties: git: $ref: '#/components/schemas/eaas.GitTags' type: object description: 'Repository Tags. Is used to represent repository tags.' required: - git eaas.RepositoryTagsRequest: properties: git: $ref: '#/components/schemas/eaas.GitTagsRequest' type: object description: 'Repository Tags Request. Is used to represent repository tags request.' required: - git eaas.Resource: properties: cpu: type: integer memory: type: integer type: object description: 'Resources. Is used to represent the hardware resources like cpu and memory attached to an Environment' required: - cpu - memory eaas.SamlResponse: properties: saml_response: type: string url: type: string format: uri type: object description: 'SAML Response Serializer. Is used to return base64 encoded SAML Response in `saml_response` and `url` parameter which contains ACS URL of remote service. User needs to be redirected to `url` doing POST with form-data `SAMLResponse`=`saml_response`' required: - saml_response - url eaas.Schedule: properties: id: type: string readOnly: true name: type: string maxLength: 256 description: type: string nullable: true maxLength: 2048 method: type: string maxLength: 256 parameter: type: object nullable: true trigger: $ref: '#/components/schemas/eaas.Trigger' environment: $ref: '#/components/schemas/eaas.EnvironmentReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string last_triggered: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string next_trigger: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true status: type: string enum: - enabled - disabled - obsolete - pending readOnly: true reason: type: string readOnly: true nullable: true type: object description: "Schedule.\n\nIs used to create a concrete Schedule of the Environment.\n\ \n`method` -- method that is going to be used. It must be inside the\n Environment.schedulables\ \ attribute.\n`name` -- a representative name of the schedule.\n`description`\ \ -- the description of what is going to do this schedule.\n`parameter` --\ \ method parameters in a dict format.\n`trigger` -- the schedule type specific\ \ data. It contains a dict that will have the required\n data.\n`events` --\ \ the schedule date events for created, update, deleted and last_triggered.\n\ `environment` -- the related environment id and type." required: - name - method - trigger eaas.ServiceEnvironment: properties: id: type: string readOnly: true type: type: string enum: - production - test - development runtime: type: string enum: - local - cloud external_id: type: string format: uuid readOnly: true status: type: string enum: - uninitialized - building - deploying - standby - running - upgrading - stopping - stopped - connected - disconnected - errored git: $ref: '#/components/schemas/eaas.GitInfo' readme_url: type: string format: uri changelog_url: type: string format: uri configuration_changed: type: boolean stats: type: string readOnly: true ui_modules: type: string readOnly: true anvil_callables: type: object readOnly: true nullable: true icon: type: string readOnly: true nullable: true type: object description: "Extension Environment.\n\nIs used to represent a concrete environment\ \ for the Extension.\n\n`id` -- unique environment id on Connect.\n`type`\ \ -- type of the environment: `Test`, `Development` or `Production`.\n`runtime`\ \ -- type of the runtime: `Local` or `Cloud`.\n`external_id` -- id of the\ \ environment in external system (i.e. Container ID on Azure).\n`status` --\ \ status of the environment. One of `Uninitialized`, `Deploying`, `Running`,\n\ `Stopping` or `Stopped`.\n`git` -- in case if environment is of `Cloud` type,\ \ this property contains git details\n from where the extension code should\ \ be downloaded.\n`readme_url` -- local path on repository to README.md file.\n\ `changelog_url` -- local path on repository to CHANGELOG.md file.\n `configuration_changed`\ \ -- Flag that indicates that configuration\n has changed and need to be updated.\n\ `stats` -- instances avg stats for cpu, memory and network usage.\n`ui_modules`\ \ -- JSON object of ui module configuration of concrete extension.\n`icon`\ \ -- icon of concrete environment for extension." required: - type - git - readme_url - changelog_url eaas.ServiceEnvironments: properties: development: $ref: '#/components/schemas/eaas.ServiceEnvironment' test: $ref: '#/components/schemas/eaas.ServiceEnvironment' production: $ref: '#/components/schemas/eaas.ServiceEnvironment' type: object description: 'Extension Environments. Is used to represent a set of environments for the Extension. By default these are three types: `Test`, `Development` and `Production`. The environments can be of different runtime: `Local` or `Cloud`.' required: - development - test - production eaas.Task: properties: id: type: string readOnly: true object: $ref: '#/components/schemas/eaas.TaskObjectType' assignee: type: string readOnly: true status: type: string enum: - scheduled - rescheduled - processing - succeeded - failed - retrying - skipped output: type: string nullable: true maxLength: 4000 environment: $ref: '#/components/schemas/eaas.EnvironmentReference' owner: $ref: '#/components/schemas/eaas.AccountReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string assigned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string completed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string rescheduled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true retry_count: type: integer maximum: 2147483647 minimum: -2147483648 rescheduled_count: type: integer maximum: 2147483647 minimum: -2147483648 runtime_total: type: number nullable: true description: Runtime total in ms processing_total: type: string readOnly: true installation: $ref: '#/components/schemas/eaas.InstallationReference' transformation_function: type: string readOnly: true type: object required: - object eaas.TaskObjectType: properties: id: type: string type: type: string category: type: string type: object required: - id - type - category eaas.TransformationFunction: properties: id: type: string readOnly: true status: type: string enum: - active - decommissioned method: type: string maxLength: 512 environment: type: string name: type: string maxLength: 256 description: type: string nullable: true maxLength: 2048 ui: $ref: '#/components/schemas/eaas.UITransformationFunction' manual: type: boolean events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string decommissioned: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true icon: type: string readOnly: true type: object required: - method - environment - name - ui eaas.Trigger: properties: type: type: string enum: - onetime - recurring - advanced start: type: string format: date-time nullable: true end: type: string format: date-time nullable: true unit: type: string enum: - hours - days - weeks - months nullable: true amount: type: integer maximum: 32767 minimum: 1 nullable: true cron_expression: type: string nullable: true maxLength: 30 date: type: string format: date-time type: object description: 'Schedule trigger type. Is used to specify a concrete Schedule type. `type` -- the schedule type: onetime, recurring or advanced. `start` -- the start date for the schedule. `end` -- the end date for the schedule (optional). `unit` -- recurring type: hour, day, week or month (for recurring type only). `amount` -- recurring amount (for recurring type only). `cron_expression` -- cron expression (for advanced type only). `date` -- one time date (for onetime type only).' required: - type eaas.UIPage: properties: url: type: string readOnly: true label: type: string maxLength: 256 icon: type: string readOnly: true extension: $ref: '#/components/schemas/eaas.ExtensionForUIPageReference' integration_point: type: string enum: - settings - devops - modules - admins - customer type: object description: 'UIPage Is used to represent a concrete UIPage. `url` -- url of concrete ui page. `label` -- label of concret ui page. `icon` -- icon of concrete ui page. `extension` -- extension information of concrete ui page. `integration_point` -- integration point type of concrete ui page.' required: - label - extension eaas.UITransformationFunction: properties: edit_dialog: type: string type: object required: - edit_dialog eaas.UpdateInfo: properties: base_image_version: type: string readOnly: true extension_version: type: string readOnly: true type: object eaas.Variable: properties: id: type: string readOnly: true name: type: string readOnly: true value: type: string maxLength: 21960 secure: type: boolean events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: "Variable.\n\n`id` -- Only present on representation\n`name` --\ \ Name of the Variable. Must match `^[A-Za-z](?:[A-Za-z0-9_\\-.]+)*$`.\n \ \ Can be set only on creation.\n`value` -- Variable value. Cannot\ \ be empty.\n`secure` -- Boolean. Indicate if this Variable contains sensitive\ \ data.\n`events` -- Only present on representation" required: - value eaas.VariableReference: properties: name: type: string maxLength: 256 value: type: string nullable: true maxLength: 21960 type: object description: 'Variable. Is used to represent the variables attached to an Environment' required: - name helpdesk.Account: properties: id: type: string name: type: string readOnly: true icon: type: string readOnly: true nullable: true type: object description: 'Connect Account details. `id` -- id of the account. `name` -- name of the account. `icon` -- icon of the account.' required: - id helpdesk.AccountSettings: properties: ttl: type: integer maximum: 2147483647 description: Number of days after which case will be closed minimum: 0 mode: type: string enum: - builtin - federated instructions: type: string nullable: true maxLength: 5000 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: 'Account Settings object. Represents Helpdesk Module configuration for a specific Vendor or Distributor account. `ttl` -- Autoclose timeout. Amount of days after which the `resolved` case will be automatically closed. `mode` -- HelpDesk mode. Can be one of `federated` (partners asking for help will be routed to the external system following your instructions and optional SSO links.) or `builtin` (partners asking for help will be creating cases directly in the Helpdesk module of your account). `instructions` -- in case of `federated` mode you should provide instructions for the partner on how to access and manage helpdesk. `events` -- information about who and when changed the settings.' helpdesk.Actor: properties: id: type: string name: type: string readOnly: true nullable: true type: object description: 'Connect User details. `id` -- id of the user. `name` -- name of the user.' required: - id helpdesk.Attachment: properties: id: type: string readOnly: true account: $ref: '#/components/schemas/helpdesk.Account' attachment: type: string format: binary size: type: string readOnly: true preview: type: string format: binary readOnly: true nullable: true name: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: type: string readOnly: true type: object description: "Represents the information about the the Helpdesk Case attachment.\n\ .\n `id` -- attachment id.\n `account` -- account `id`, `name` and `icon`.\n\ \ `attachment` -- URI to the file associated with this attachment.\n \ \ `size` -- attachment size.\n `preview` -- URI to the file preview associated\ \ with this attachment.\n `name` -- attachment name.\n `events` -- information\ \ about who and when created the attachment.\n `type` -- MIME type of the\ \ attachment." required: - attachment helpdesk.Case: properties: id: type: string readOnly: true product: $ref: '#/components/schemas/helpdesk.Product' nullable: true subject: type: string maxLength: 300 description: type: string maxLength: 10000 priority: type: string enum: - 0 - 1 - 2 - 3 minimum: -2147483648 maximum: 2147483647 state: type: string enum: - pending - inquiring - resolved - closed type: type: string enum: - technical - business issuer: $ref: '#/components/schemas/helpdesk.Issuer' receiver: $ref: '#/components/schemas/helpdesk.Receiver' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string pending: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string inquiring: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string resolved: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string closed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true rating: type: string enum: - 1 - 2 - 3 - 4 - 5 readOnly: true nullable: true feedback: type: string readOnly: true nullable: true type: object description: "Represents the information of the Helpdesk Case.\n\n`id` -- unique\ \ id of the Helpdesk Case.\n`product` -- in case if a Helpdesk Case is created\ \ about an issue in the product, this\nsection contains such product details.\n\ `subject` -- subject of the Helpdesk Case.\n`description` -- Description of\ \ the Helpdesk Case.\n`priority` -- Priority of the Helpdesk Case: `0 low`,\ \ `1 medium`, `2 high`, `3 urgent`.\n`state` -- current state of the Helpdesk\ \ Case. One of: `pending`, `inquiring`, `resolved`,\n`closed`.\n`issuer` --\ \ partner details about who initiated the Helpdesk Case.\n`receiver` -- partner\ \ details about who is the target of the Helpdesk Case.\n`events` -- information\ \ about who and when changed the state of the Helpdesk Case.\n`rating` --\ \ optional value to be used when closing the Helpdesk Case. Can be one of\ \ from `1`\ntill `5`.\nBeing `1` very poor satisfaction and `5` very high\ \ satisfaction.\n`feedback` -- optional value to be used when closing the\ \ Helpdesk Case. Freeform comments\n about case lifecycle." required: - subject - description - type - receiver helpdesk.Issuer: properties: account: $ref: '#/components/schemas/helpdesk.Account' agent: $ref: '#/components/schemas/helpdesk.Actor' recipients: type: array items: $ref: '#/components/schemas/helpdesk.Actor' type: object description: "Represents the partner information of the Helpdesk Case issuer.\n\ .\n `account` -- account `id`, `name` and `icon`.\n `agent` -- user\ \ details to which the Helpdesk Case is assigned.\n `recipients` -- additional\ \ list of users who will be receiving updated about the Helpdesk Case." helpdesk.Product: properties: id: type: string name: type: string readOnly: true icon: type: string readOnly: true nullable: true type: object description: 'Connect Product details. `id` -- id of the product. `name` -- name of the product. `icon` -- icon of the product.' required: - id helpdesk.Receiver: properties: account: $ref: '#/components/schemas/helpdesk.Account' agent: $ref: '#/components/schemas/helpdesk.Actor' recipients: type: array items: $ref: '#/components/schemas/helpdesk.Actor' type: object description: "Represents the partner information of the Helpdesk Case receiver.\n\ .\n `account` -- account `id`, `name` and `icon`.\n `agent` -- user\ \ details to which the Helpdesk Case is assigned.\n `recipients` -- additional\ \ list of users who will be receiving updated about the Helpdesk Case." required: - account localization.Account: properties: id: type: string readOnly: true name: type: string readOnly: true icon: type: string nullable: true maxLength: 2000 type: object description: 'Connect Account details. `id` -- id of the account. `name` -- name of the account. `icon` -- icon of the account.' localization.AutoTranslationObject: properties: enabled: type: boolean status: type: string error_message: type: string type: object description: 'Represents Automatic Translation Status of the Translation `enabled` -- indicates if auto translation is enabled for this Translation `status` -- indicates the status of the last automatic translation attempt' localization.Locale: properties: id: type: string readOnly: true name: type: string readOnly: true local_name: type: string readOnly: true auto_translation: type: boolean readOnly: true stats: $ref: '#/components/schemas/localization.LocaleStats' marketplaces: type: array items: $ref: '#/components/schemas/localization.Marketplace' type: object description: 'Represents a particular Locale object `id` -- id of the Locale `name` -- name of the Locale `local_name` -- local_name of the Locale `auto_translation` -- if this Locale is auto translated `stats` -- object containing stats about amount of translations for this Locale `marketplaces` -- list of marketplaces this Locale is supported by' required: - marketplaces localization.LocaleReference: properties: id: type: string readOnly: true name: type: string readOnly: true auto_translation: type: boolean readOnly: true type: object description: 'Represents a link to particular Locale `id` -- id of the Locale `name` -- name of the Locale' localization.LocaleStats: properties: translations: type: integer readOnly: true pim_translations: type: integer readOnly: true type: object description: 'Represents amount of translations for the locale `translations` -- amount of translations for the Locale' localization.LocalizationContext: properties: id: type: string readOnly: true instance_id: type: string maxLength: 100 name: type: string maxLength: 256 icon: type: string nullable: true maxLength: 2000 type: type: string enum: - product - pim translations: type: array items: $ref: '#/components/schemas/localization.TranslationReference' primary_locale: $ref: '#/components/schemas/localization.LocaleReference' type: object description: 'Represents a particular Localization Context `id` -- id of the Localization Context `instance_id` -- id of Connect object linked to the Localization Context, i.e. Product ID `name` -- name of the Localization Context `type` -- type of the Localization Context. Can have only one single value: `product` `translations` -- translations linked to this Localization Context `icon` -- Localization Context icon `primary_locale` -- The Locale details of Primary translation for this Localization Context' required: - instance_id - name - translations localization.LocalizationContextReference: properties: id: type: string readOnly: true instance_id: type: string readOnly: true name: type: string readOnly: true icon: type: string readOnly: true nullable: true type: type: string enum: - product - pim readOnly: true type: object description: 'Represents a link to particular Localization Context `id` -- id of the Localization Context `instance_id` -- id of Connect object linked to the Localization Context, i.e. Product ID `name` -- name of the Localization Context `type` -- type of the Localization Context. Can have only one single value: `product` `icon` -- Localization Context icon' localization.Marketplace: properties: id: type: string readOnly: true name: type: string maxLength: 255 icon: type: string nullable: true maxLength: 2000 type: object description: 'Represents a link to a particular Marketplace `id` -- Marketplace id `name` -- Marketplace name `icon` -- Marketplace icon' required: - name localization.Translation: properties: id: type: string context: $ref: '#/components/schemas/localization.LocalizationContextReference' readOnly: true owner: $ref: '#/components/schemas/localization.Account' locale: $ref: '#/components/schemas/localization.LocaleReference' readOnly: true description: type: string nullable: true maxLength: 4000 stats: $ref: '#/components/schemas/localization.TranslationStats' auto: $ref: '#/components/schemas/localization.AutoTranslationObject' status: type: string readOnly: true events: type: object properties: updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true primary: type: boolean readOnly: true type: object description: 'Represents a particular Translation object `id` -- id of the Translation `locale` -- Locale of the Translation `primary` -- if this Translation is primary `status` -- Translation status in scope of the Account making API request `owner` -- Translation owner `description` -- Translation description `context` -- Translation Localization Context `auto` -- Details of the automated translation for the Translation `stats` -- Translation statistics: total amount of attributes vs. translated attributes `events` -- Details about who and when created and updated the Translation' localization.TranslationAttribute: properties: key: type: string readOnly: true value: type: string readOnly: true nullable: true comment: type: string readOnly: true nullable: true maxLength: 4000 auto_translated: type: boolean readOnly: true events: type: object properties: updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true object: type: object properties: id: type: string model: type: string readOnly: true type: object description: 'Represents a particular Translation Attribute object `key` -- key of the Translation Attribute `value` -- value of the Translation Attribute `comment` -- any additional information provided by the person and/or service doing translation `auto_translated` -- indicates if this Attribute was automatically translated or not `events` -- Details about who and when created and updated the Translation Attribute' localization.TranslationCreateOnContextCreate: properties: id: type: string readOnly: true locale: $ref: '#/components/schemas/localization.LocaleReference' primary: type: boolean status: type: string readOnly: true owner: $ref: '#/components/schemas/localization.Account' description: type: string nullable: true maxLength: 4000 auto: $ref: '#/components/schemas/localization.AutoTranslationObject' type: object description: 'Represents a Translation object provided during creation of Localization Context. This serializer is only used by Devportal when creating a new Localization Context. `id` -- id of the Translation `locale` -- Locale of the Translation `primary` -- if this Translation is primary. `status` -- Translation status `description` -- Translation description `owner` -- owner of the Translation `auto` -- Details of the automated translation for the Translation' required: - locale localization.TranslationReference: properties: id: type: string readOnly: true locale: $ref: '#/components/schemas/localization.LocaleReference' primary: type: boolean status: type: string readOnly: true owner: $ref: '#/components/schemas/localization.Account' type: object description: 'Represents a link to a particular Translation `id` -- id of the Translation `locale` -- locale of the Translation `primary` -- if this Translation is primary `status` -- Translation status `owner` -- owner of the Translation' required: - locale localization.TranslationStats: properties: total: type: integer readOnly: true translated: type: integer readOnly: true type: object description: 'Represents Translation Statistics `total` -- total amount of attributes linked to the Translation `translated` -- amount of attributes linked to the Translation which have `value` property not empty' localization.TranslationTask: properties: id: type: string readOnly: true type: type: string enum: - attributes_autotranslation arguments: type: object nullable: true status: type: string enum: - new - success - processing - error events: type: object properties: finished: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true error_message: type: string nullable: true maxLength: 4000 type: object description: 'Represents a particular Translation Task Context `id` -- id of the Translation Task `type` -- type of the Translation Task. Can be one of `attributes_export`, `attributes_import` or `attributes_autotranslation` `arguments` -- input or output arguments of the Translation Task `status` -- status of the Translation Task. Can be one of `new`, `success`, `processing` or `error` `file` -- depending on the task type, it can be either input data or output data `error_message` -- error message in case if task completes with error `events` -- events related with the Task: created.at and .by, and finished.at' media.Account: properties: id: type: string maxLength: 16 name: type: string maxLength: 64 icon: type: string nullable: true maxLength: 2000 type: object required: - id - name media.File: properties: id: type: string readOnly: true file: readOnly: true size: type: integer readOnly: true folder: $ref: '#/components/schemas/media.Folder' owner: $ref: '#/components/schemas/media.Account' preview: readOnly: true preview_size: type: integer readOnly: true nullable: true name: type: string readOnly: true mime_type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string confirmed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true access: type: object properties: account_id: type: object properties: view: type: boolean delete: type: boolean authenticated: type: object properties: view: type: boolean readOnly: true type: object media.FileCreate: properties: id: type: string readOnly: true file: type: string format: binary size: type: integer readOnly: true folder: $ref: '#/components/schemas/media.Folder' owner: $ref: '#/components/schemas/media.IdWrite' preview: type: string format: binary preview_size: type: integer readOnly: true nullable: true name: type: string readOnly: true mime_type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string confirmed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true access: type: object properties: account_id: type: object properties: view: type: boolean delete: type: boolean authenticated: type: object properties: view: type: boolean type: object required: - file media.FileImport: properties: id: type: string readOnly: true file: type: string maxLength: 1024 size: type: integer readOnly: true folder: $ref: '#/components/schemas/media.Folder' owner: $ref: '#/components/schemas/media.IdWrite' preview: readOnly: true preview_size: type: integer readOnly: true nullable: true name: type: string readOnly: true mime_type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string confirmed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true access: type: object properties: account_id: type: object properties: view: type: boolean delete: type: boolean authenticated: type: object properties: view: type: boolean type: object required: - file media.FileUpdate: properties: id: type: string readOnly: true file: type: string format: binary size: type: integer readOnly: true folder: $ref: '#/components/schemas/media.Folder' owner: $ref: '#/components/schemas/media.Account' preview: type: string format: binary preview_size: type: integer readOnly: true nullable: true name: type: string readOnly: true mime_type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string confirmed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true access: type: object properties: account_id: type: object properties: view: type: boolean delete: type: boolean authenticated: type: object properties: view: type: boolean type: object media.Folder: properties: name: type: string maxLength: 50 type: type: string maxLength: 50 type: object required: - name - type media.IdWrite: properties: id: type: string writeOnly: true type: object required: - id ns.Account: properties: id: type: string maxLength: 100 name: type: string maxLength: 100 type: object required: - id - name ns.AccountNotification: properties: id: type: string readOnly: true enabled: type: boolean event: $ref: '#/components/schemas/ns.NotificationEvent' permissions: type: string readOnly: true type: object ns.AccountSetting: properties: id: type: string name: type: string enum: - region - timeformat - timezone value: type: string maxLength: 2000 type: object required: - id - value ns.EmailTemplate: properties: id: type: string readOnly: true subject: type: string maxLength: 2000 body: type: string system: type: boolean readOnly: true description: To identify template as read-only. type: object required: - subject - body ns.GroupReference: properties: id: type: string name: type: string readOnly: true color: type: string readOnly: true nullable: true description: type: string readOnly: true is_decommissioned: type: string readOnly: true type: object required: - id ns.LastTriggerInfo: properties: time: type: string format: date-time response: type: object duration: type: integer maximum: 2147483647 minimum: -2147483648 status: type: string enum: - success - failure status_code: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true errors: type: string readOnly: true type: object required: - response - duration - status ns.NotificationEvent: properties: id: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 2000 group: type: string enum: - accounts - helpdesk - leads - listing - reports - sla - subscriptions - tier_configs - users - offers - products - triggered_externally - commerce - integrations system: type: boolean description: System events can't be managed by account type: object required: - name - group ns.NotificationRule: properties: id: type: string readOnly: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 name: type: string maxLength: 100 condition: type: string enabled: type: boolean default: type: string readOnly: true template: $ref: '#/components/schemas/ns.EmailTemplate' recipients: $ref: '#/components/schemas/ns.Recipients' account_notification: type: string writeOnly: true type: object required: - template - recipients - account_notification ns.Product: properties: id: type: string maxLength: 100 name: type: string maxLength: 100 icon: type: string maxLength: 2000 type: object required: - id - name ns.Recipients: properties: users: type: array items: $ref: '#/components/schemas/ns.UserReference' groups: type: array items: $ref: '#/components/schemas/ns.GroupReference' type: object required: - users - groups ns.Stats: properties: events: type: integer maximum: 2147483647 minimum: -2147483648 triggers: type: integer maximum: 2147483647 minimum: -2147483648 success_triggers: type: integer maximum: 2147483647 minimum: -2147483648 failure_triggers: type: integer maximum: 2147483647 minimum: -2147483648 failure_since_last_success: type: integer maximum: 2147483647 minimum: -2147483648 type: object ns.User: properties: id: type: string maxLength: 100 name: type: string maxLength: 100 email: type: string maxLength: 50 type: object required: - id - name ns.UserReference: properties: id: type: string name: type: string readOnly: true nullable: true email: type: string format: email readOnly: true icon: type: string nullable: true maxLength: 2000 blocklisted: type: boolean readOnly: true type: object required: - id ns.Webhook: properties: id: type: string readOnly: true type: type: string enum: - event - validator - inquiring_validator - change_validator - change_inquiring_validator - renew_validator - renew_inquiring_validator - transfer_validator - transfer_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 object_class: type: string enum: - fulfillment_request - tier_config_request - tier_account_request - listing_request - billing_request - usage_file label: type: string maxLength: 100 active: type: boolean external_url: type: string format: uri maxLength: 4096 jwt_secret: type: string maxLength: 100 description: type: string nullable: true http_method: type: string enum: - GET - POST product: $ref: '#/components/schemas/ns.Product' data: type: object headers: type: object api_url: type: string format: uri readOnly: true created_at: type: string format: date-time readOnly: true created_by: $ref: '#/components/schemas/ns.User' modified_at: type: string format: date-time readOnly: true nullable: true modified_by: $ref: '#/components/schemas/ns.User' account: $ref: '#/components/schemas/ns.Account' earliest_possible_trigger: type: string format: date-time readOnly: true nullable: true stats: $ref: '#/components/schemas/ns.Stats' last_event: type: string format: date-time readOnly: true nullable: true last_success: $ref: '#/components/schemas/ns.LastTriggerInfo' last_failure: $ref: '#/components/schemas/ns.LastTriggerInfo' type: object required: - label - external_url - jwt_secret - data - headers offers.Account: properties: id: type: string readOnly: true name: type: string maxLength: 64 type: object description: Account representation. required: - name offers.AttributeForm: properties: id: type: string readOnly: true name: type: string readOnly: true nullable: true type: type: string enum: - preset_plan - preset_switch - blueprint_plan readOnly: true scope: type: string enum: - commerce readOnly: true groups: type: array items: type: object type: object description: ReadOnly Serializer for Attribute Form required: - groups offers.BlueprintPlan: properties: id: type: string readOnly: true preset: $ref: '#/components/schemas/offers.PresetWriteReference' form: $ref: '#/components/schemas/offers.AttributeForm' status: type: string enum: - draft - active - endofsale readOnly: true nullable: true countries: type: array items: $ref: '#/components/schemas/offers.Country' end_of_sale_notes: type: string readOnly: true nullable: true events: type: object properties: saleended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object offers.CommerceBlueprintPlanCollectionAttributes: properties: attributes: type: string plan: $ref: '#/components/schemas/offers.PlanReference' type: object required: - attributes - plan offers.Constraint: properties: type: type: string enum: - min_max min: type: integer minimum: 0 max: type: integer minimum: 1 nullable: true type: object required: - type - min - max offers.Country: properties: id: type: string end_of_access: type: boolean readOnly: true type: object required: - id offers.Feature: properties: id: type: string readOnly: true name: type: string maxLength: 256 description: type: string nullable: true position: type: integer readOnly: true nullable: true gravity: type: object writeOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true group: $ref: '#/components/schemas/offers.FeaturesGroup' plans: type: array items: $ref: '#/components/schemas/offers.FeaturePlanValue' type: object description: Feature representation. required: - name - group - plans offers.FeaturePlanValue: properties: id: type: string readOnly: true value: type: string maxLength: 64 type: object description: Plan values in scope of Feature representation. required: - value offers.FeaturesGroup: properties: id: type: string readOnly: true name: type: string maxLength: 256 description: type: string nullable: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: Feature group representation. offers.IdWrite: properties: id: type: string writeOnly: true type: object required: - id offers.Item: properties: id: type: string maxLength: 100 name: type: string readOnly: true status: type: string enum: - draft - published - endofsale readOnly: true type: type: string enum: - reservation - ppu readOnly: true type: object description: Item representation required: - id offers.Offer: properties: id: type: string readOnly: true name: type: string maxLength: 512 description: type: string nullable: true owner: $ref: '#/components/schemas/offers.Account' product: $ref: '#/components/schemas/offers.Product' stats: type: string readOnly: true status: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true changes_description: type: string readOnly: true nullable: true description: Change log for offer version public: type: boolean readOnly: true version: type: integer readOnly: true nullable: true type: type: string enum: - generic - commerce sample: type: boolean writeOnly: true description: Passed on creation, means should sample offer be created. type: object required: - name - product offers.OfferItem: properties: id: type: string readOnly: true name: type: string maxLength: 128 description: type: string nullable: true commitments: type: array items: type: string nullable: true plans: type: string nullable: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: Offer Item representation required: - name offers.OfferItemValue: properties: offer_item: type: string readOnly: true item: $ref: '#/components/schemas/offers.Item' period: type: string enum: - days_7_trial - days_14_trial - monthly - monthly_trial - yearly - years_2 - years_3 - years_4 - years_5 - years_6 - onetime - trial constraint: $ref: '#/components/schemas/offers.Constraint' plan: type: string readOnly: true commitments: type: string readOnly: true type: object description: Offer Item value representation required: - period offers.OfferVersion: properties: id: type: string readOnly: true name: type: string readOnly: true description: type: string readOnly: true nullable: true owner: $ref: '#/components/schemas/offers.Account' product: $ref: '#/components/schemas/offers.Product' stats: type: string readOnly: true status: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true changes_description: type: string nullable: true description: Change log for offer version public: type: boolean version: type: integer readOnly: true nullable: true type: type: string readOnly: true type: object description: Offer representation. Field 'stats.listings' is accessed only by Vendor. offers.Plan: properties: id: type: string readOnly: true name: type: string maxLength: 256 color: type: string maxLength: 32 periods: type: array items: type: string commitments: type: array items: type: string nullable: true description: type: string nullable: true external_id: type: string nullable: true position: type: integer readOnly: true nullable: true gravity: type: object writeOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: Plan representation required: - name - color - periods offers.PlanReference: properties: id: type: string readOnly: true type: object offers.PresetCreate: properties: id: type: string readOnly: true name: type: string type: type: string enum: - plan - switch external_id: type: string nullable: true form: $ref: '#/components/schemas/offers.AttributeForm' product: $ref: '#/components/schemas/offers.Product' status: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - name - type - form - product offers.PresetUpdate: properties: id: type: string readOnly: true name: type: string type: type: string readOnly: true external_id: type: string nullable: true form: $ref: '#/components/schemas/offers.AttributeForm' product: $ref: '#/components/schemas/offers.Product' status: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - name - form offers.PresetVersion: properties: id: type: string readOnly: true name: type: string readOnly: true description: type: string nullable: true type: type: string readOnly: true external_id: type: string readOnly: true form: $ref: '#/components/schemas/offers.AttributeForm' product: $ref: '#/components/schemas/offers.Product' version: type: integer readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object offers.PresetWriteReference: properties: id: type: string readOnly: true name: type: string readOnly: true type: object offers.Product: properties: id: type: string readOnly: true name: type: string readOnly: true icon: type: string nullable: true maxLength: 2000 status: type: string enum: - draft - indevelopment - oncertification - published - initializationfailed - deleted - endofsale readOnly: true type: object description: Product representation. offers.Switch: properties: id: type: string readOnly: true type: type: string enum: - upgrade - downgrade - eos - change from: $ref: '#/components/schemas/offers._Plan' to: $ref: '#/components/schemas/offers._Plan' preset: $ref: '#/components/schemas/offers._Preset' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string saleended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true status: type: string enum: - active - endofsale readOnly: true nullable: true end_of_sale_notes: type: string readOnly: true nullable: true type: object offers.SwitchCreate: properties: type: type: string enum: - upgrade - downgrade - eos - change preset: $ref: '#/components/schemas/offers.IdWrite' to: $ref: '#/components/schemas/offers.IdWrite' from: $ref: '#/components/schemas/offers.IdWrite' type: object required: - type - to offers.SwitchUpdate: properties: type: type: string enum: - upgrade - downgrade - eos - change preset: $ref: '#/components/schemas/offers.IdWrite' type: object offers._Plan: properties: id: type: string readOnly: true name: type: string maxLength: 256 type: object required: - name offers._Preset: properties: id: type: string readOnly: true name: type: string maxLength: 256 type: object required: - name pim.AccountReference: properties: id: type: string maxLength: 16 name: type: string maxLength: 64 icon: type: string nullable: true maxLength: 2000 type: object required: - id - name pim.Attribute: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string maxLength: 64 description: type: string nullable: true maxLength: 512 scope: type: string enum: - product - item type: type: string enum: - text - dropdown - number - file - image constraints: type: object properties: choices: type: array items: type: object properties: name: type: string value: type: string unit: type: string file_max_size: type: number file_allowed_types: type: array items: type: string readOnly: true hint: type: string readOnly: true placeholder: type: string readOnly: true group: $ref: '#/components/schemas/pim.GroupReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string grouped: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 type: object required: - name - external_id - scope - type - group pim.AttributeCreate: properties: name: type: string maxLength: 128 description: type: string nullable: true maxLength: 512 external_id: type: string maxLength: 64 scope: type: string enum: - product - item type: type: string enum: - text - dropdown - number - file - image constraints: $ref: '#/components/schemas/pim._ConstraintsWrite' hint: type: string nullable: true maxLength: 128 placeholder: type: string nullable: true maxLength: 128 gravity: $ref: '#/components/schemas/pim.Gravity' group: $ref: '#/components/schemas/pim.IdWrite' type: object required: - name - external_id - scope - type - group pim.AttributeReference: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string maxLength: 64 type: object required: - name - external_id pim.AttributeUpdate: properties: name: type: string maxLength: 128 description: type: string nullable: true maxLength: 512 external_id: type: string maxLength: 64 gravity: $ref: '#/components/schemas/pim.Gravity' constraints: $ref: '#/components/schemas/pim._ConstraintsWrite' hint: type: string nullable: true maxLength: 128 placeholder: type: string nullable: true maxLength: 128 group: $ref: '#/components/schemas/pim.IdWrite' type: object pim.Category: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 class: $ref: '#/components/schemas/pim.ClassReference' parent: $ref: '#/components/schemas/pim.CategoryReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string classified: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true depth: type: integer maximum: 2147483647 minimum: 0 owner: $ref: '#/components/schemas/pim.AccountReference' position: type: integer maximum: 2147483647 nullable: true minimum: 0 stats: type: object properties: children: type: integer products: type: integer catalog: type: integer readOnly: true type: object required: - name - class - parent - owner pim.CategoryCreate: properties: name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 gravity: $ref: '#/components/schemas/pim.HierarchyGravity' class: $ref: '#/components/schemas/pim.IdWrite' type: object required: - name - class pim.CategoryReference: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 type: object required: - name pim.CategoryUpdate: properties: name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 gravity: $ref: '#/components/schemas/pim.HierarchyGravity' class: $ref: '#/components/schemas/pim.IdWrite' type: object pim.Class: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 parent: $ref: '#/components/schemas/pim.ClassReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true depth: type: integer maximum: 2147483647 minimum: 0 position: type: integer maximum: 2147483647 nullable: true minimum: 0 stats: type: object properties: children: type: integer products: type: integer readOnly: true categories: type: array items: type: object properties: id: type: string name: type: string external_id: type: string readOnly: true type: object required: - name - parent pim.ClassAttributeSerializerSpec: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string maxLength: 64 description: type: string nullable: true maxLength: 512 scope: type: string enum: - product - item type: type: string enum: - text - dropdown - number - file - image constraints: type: object properties: choices: type: array items: type: object properties: name: type: string value: type: string unit: type: string file_max_size: type: number file_allowed_types: type: array items: type: string readOnly: true hint: type: string readOnly: true placeholder: type: string readOnly: true group: $ref: '#/components/schemas/pim.GroupReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string grouped: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 class: $ref: '#/components/schemas/pim.ClassReference' type: object required: - name - external_id - scope - type - group - class pim.ClassAttributeWithValueSerializerSpec: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string maxLength: 64 description: type: string nullable: true maxLength: 512 scope: type: string enum: - product - item type: type: string enum: - text - dropdown - number - file - image constraints: type: object properties: choices: type: array items: type: object properties: name: type: string value: type: string unit: type: string file_max_size: type: number file_allowed_types: type: array items: type: string readOnly: true hint: type: string readOnly: true placeholder: type: string readOnly: true group: $ref: '#/components/schemas/pim.GroupReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string grouped: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 class: $ref: '#/components/schemas/pim.ClassReference' value: type: string type: object required: - name - external_id - scope - type - group - class - value pim.ClassCreate: properties: name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 gravity: $ref: '#/components/schemas/pim.HierarchyGravity' type: object required: - name pim.ClassReference: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 type: object required: - name pim.ClassUpdate: properties: name: type: string maxLength: 128 external_id: type: string nullable: true maxLength: 64 gravity: $ref: '#/components/schemas/pim.Gravity' type: object pim.ClassVariantSerializerSpec: properties: id: type: string readOnly: true name: readOnly: true external_id: type: string nullable: true maxLength: 64 attributes: type: array items: $ref: '#/components/schemas/pim.AttributeReference' readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true class: $ref: '#/components/schemas/pim.ClassReference' type: object required: - class pim.Gravity: properties: after: type: string maxLength: 24 before: type: string maxLength: 24 type: object pim.Group: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string maxLength: 64 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 stats: type: object properties: attributes: type: integer readOnly: true attributes: type: array items: type: object properties: id: type: string name: type: string external_id: type: string readOnly: true type: object required: - name - external_id pim.GroupCreate: properties: name: type: string maxLength: 128 external_id: type: string maxLength: 64 gravity: $ref: '#/components/schemas/pim.Gravity' type: object required: - name - external_id pim.GroupReference: properties: id: type: string readOnly: true name: type: string maxLength: 128 external_id: type: string maxLength: 64 type: object required: - name - external_id pim.GroupUpdate: properties: name: type: string maxLength: 128 external_id: type: string maxLength: 64 gravity: $ref: '#/components/schemas/pim.Gravity' type: object pim.HierarchyGravity: properties: after: type: string maxLength: 24 before: type: string maxLength: 24 inside: type: string maxLength: 24 type: object pim.IdWrite: properties: id: type: string writeOnly: true type: object required: - id pim.Taxonomy: properties: id: type: string readOnly: true partner: $ref: '#/components/schemas/pim.AccountReference' category: $ref: '#/components/schemas/pim.CategoryReference' class: $ref: '#/components/schemas/pim.ClassReference' variant: $ref: '#/components/schemas/pim.VariantReference' readOnly: true owner: $ref: '#/components/schemas/pim.AccountReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object required: - partner - category - class - owner pim.TaxonomyAttributeUpdate: properties: value: type: string nullable: true type: object required: - value pim.TaxonomyCreate: properties: partner: $ref: '#/components/schemas/pim.IdWrite' category: $ref: '#/components/schemas/pim.IdWrite' variant: $ref: '#/components/schemas/pim.IdWrite' type: object required: - partner pim.TaxonomyUpdate: properties: category: $ref: '#/components/schemas/pim.IdWrite' variant: $ref: '#/components/schemas/pim.IdWrite' type: object pim.Variant: properties: id: type: string readOnly: true name: readOnly: true external_id: type: string nullable: true maxLength: 64 attributes: type: array items: $ref: '#/components/schemas/pim.AttributeReference' readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object pim.VariantEdit: properties: external_id: type: string nullable: true maxLength: 64 attributes: type: array items: $ref: '#/components/schemas/pim.IdWrite' type: object pim.VariantReference: properties: id: type: string readOnly: true name: readOnly: true external_id: type: string nullable: true maxLength: 64 type: object pim._Choice: properties: name: type: string maxLength: 64 value: type: string maxLength: 64 type: object required: - name - value pim._ConstraintsWrite: properties: choices: type: array items: $ref: '#/components/schemas/pim._Choice' unit: type: string maxLength: 32 file_max_size: type: integer maximum: 67108864 minimum: 1024 file_allowed_types: type: array items: {} type: object pricing.Account: properties: id: type: string readOnly: true name: type: string maxLength: 64 type: object required: - name pricing.Action: properties: {} type: object description: POST action data pricing.Item: properties: global_id: type: string readOnly: true display_name: type: string readOnly: true mpn: type: string readOnly: true nullable: true product: $ref: '#/components/schemas/pricing.Product' type: object description: Product Item representation. pricing.PriceAdjustment: properties: id: type: string readOnly: true status: type: string enum: - processing - success - partial - failed readOnly: true uploaded_file: type: string format: uri-reference description: Link to XLSX bulk data update file. processed_file: type: string format: uri-reference readOnly: true nullable: true description: Link to XLSX file with processing results. error_detail: type: string readOnly: true nullable: true description: Description of file format level parse errors. events: type: object properties: activated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string canceled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string expired: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string scheduled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: PriceAdjustment representation. required: - uploaded_file pricing.PriceList: properties: id: type: string readOnly: true name: type: string maxLength: 512 description: type: string maxLength: 2048 currency: 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 compatibility: type: string enum: - commerce nullable: true precision: type: number maximum: 0.1 minimum: 0 description: Maximum PricePoints precision. Must be power of -10 (0.1, 0.01, etc.). Each PricePoint will be checked for precision excess. status: type: string enum: - draft - scheduled - active - terminated readOnly: true owner: $ref: '#/components/schemas/pricing.Account' 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. products: type: array items: $ref: '#/components/schemas/pricing.Product' stats: type: object properties: products: type: integer readOnly: true listings: type: integer readOnly: true listings_alt: type: integer readOnly: true readOnly: true events: type: object properties: activated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string canceled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string expired: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string scheduled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: 'PriceList representation. Fields ''stats.listings'' and ''stats.listings_alt'' are accessed only by Vendor.' required: - name - description - currency - attributes - products pricing.PriceListRelated: properties: id: type: string readOnly: true name: type: string readOnly: true currency: 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 readOnly: true precision: type: number maximum: 1000000000000000 minimum: -1000000000000000 readOnly: true description: Maximum PricePoints precision. Must be power of -10 (0.1, 0.01, etc.). Each PricePoint will be checked for precision excess. status: type: string enum: - draft - scheduled - active - terminated readOnly: true owner: $ref: '#/components/schemas/pricing.Account' attributes: items: type: object minItems: 1 type: array uniqueItems: true readOnly: 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. stats: type: object properties: products: type: integer readOnly: true listings: type: integer readOnly: true listings_alt: type: integer readOnly: true readOnly: true type: object description: 'Nested PriceList representation. Fields ''stats.listings'' and ''stats.listings_alt'' are accessed only by Vendor.' pricing.PriceListVersion: properties: id: type: string readOnly: true 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. status: type: string enum: - processing - draft - scheduled - active - expired readOnly: true pricelist: $ref: '#/components/schemas/pricing.PriceListRelated' xlsx_file: type: string format: uri-reference readOnly: true nullable: true description: Link to XLSX representation file. events: type: object properties: activated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string canceled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string expired: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string scheduled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: PriceListVersion representation. required: - description - base pricing.PriceListVersionReference: properties: id: type: string readOnly: true start_at: type: string format: date-time readOnly: true 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. pricing.PricePoint: properties: id: type: string readOnly: true item: $ref: '#/components/schemas/pricing.Item' status: type: string enum: - filled - empty readOnly: true attributes: type: object type: object description: PricePoint representation. required: - attributes pricing.Product: properties: id: type: string readOnly: true name: type: string readOnly: true icon: type: string readOnly: true nullable: true description: type: string readOnly: true nullable: true type: object reporting.AccountReference: properties: id: type: string readOnly: true name: type: string maxLength: 64 type: object required: - name reporting.GitCredentials: properties: username: type: string nullable: true maxLength: 256 password: type: string nullable: true maxLength: 512 type: object description: 'Git Credentials. Is used to represent input object to request git tags. You need to provide `username` and `password` to your git repository as input data.' reporting.GitInfo: properties: url: type: string format: uri maxLength: 200 tag: type: string maxLength: 256 commit: type: string nullable: true maxLength: 64 auth: $ref: '#/components/schemas/reporting.GitCredentials' type: object description: 'Git Info. Is used to represent git repository information' required: - url - tag reporting.GitInfoCreate: properties: url: type: string format: uri maxLength: 200 tag: type: string maxLength: 256 auth: $ref: '#/components/schemas/reporting.GitCredentials' type: object description: 'Git Info. Is used to represent git repository information while adding new repository. You need to provide `url` and `tag` parameters as input data. Optionally you can provide `auth` if your repository requires authentication.' required: - url - tag reporting.GitTags: properties: url: type: string format: uri auth: $ref: '#/components/schemas/reporting.GitCredentials' tags: type: array items: type: string type: object description: 'Git Tags. Is used to represent repository tags' required: - url reporting.GitTagsRequest: properties: url: type: string format: uri auth: $ref: '#/components/schemas/reporting.GitCredentials' type: object description: 'Git Tags Request. Is used to represent input object to request git tags. You need to provide `url` and `auth` as input data.' required: - url reporting.RepoStats: properties: templates_count: type: integer readOnly: true monthly_executions: type: integer readOnly: true total_executions: type: integer readOnly: true type: object description: 'Repository Stats. Is used to represent statistics about repository. `templates_count` -- amount of templates registered for this repository, `monthly_executions` -- amount of executions in current month, `total_executions` -- amount of all executions.' reporting.Report: properties: id: type: string readOnly: true name: type: string maxLength: 512 description: type: string nullable: true maxLength: 2048 revision: type: integer maximum: 2147483647 minimum: -2147483648 template: $ref: '#/components/schemas/reporting.ReportTemplateReference' parameters: type: object nullable: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string started: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true report_size: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true timeout: type: boolean status: type: string enum: - pending - deploying - running - succeeded - failed owner: $ref: '#/components/schemas/reporting.AccountReference' failure_output: type: string nullable: true maxLength: 4096 schedule: $ref: '#/components/schemas/reporting.ReportScheduleReference' renderer: type: string maxLength: 256 report_file: type: string readOnly: true report_extension: type: string readOnly: true progress: $ref: '#/components/schemas/reporting.ReportStatsProgress' timing: $ref: '#/components/schemas/reporting.ReportTiming' type: object description: 'Report. Is used to represent a concrete report execution.' required: - name - template - owner - schedule - progress reporting.ReportCreate: properties: name: type: string maxLength: 512 description: type: string nullable: true maxLength: 2048 template: $ref: '#/components/schemas/reporting.ReportTemplateCreate' parameters: type: array items: type: object nullable: true renderer: type: string maxLength: 256 type: object description: 'Create report. Is used to create a new report and execute it. You need to provide the `name`, `description` and `template` data as input. You also can optionally provide list of parameters in `parameters` section.' required: - name - template reporting.ReportFail: properties: notes: type: string traceback: type: string block: type: boolean type: object description: 'Fail report. Is used to fail a concrete report execution. You need to provide the `notes`, as reason for failure, `block` and optional `traceback` data as input.' required: - notes - block reporting.ReportRepositoryReference: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 512 git: $ref: '#/components/schemas/reporting.GitInfo' type: object description: 'Report repository. Is used to represent repository attached to this report' required: - git reporting.ReportSchedule: properties: id: type: string readOnly: true name: type: string maxLength: 512 description: type: string nullable: true maxLength: 2048 events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string last_execution: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string next_execution: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true notes: type: string nullable: true maxLength: 2048 template: $ref: '#/components/schemas/reporting.ReportTemplateReference' trigger: $ref: '#/components/schemas/reporting.ReportScheduleTrigger' parameters: type: array items: type: object nullable: true status: type: string enum: - enabled - disabled renderer: type: string maxLength: 256 owner: $ref: '#/components/schemas/reporting.AccountReference' stats: $ref: '#/components/schemas/reporting.ReportScheduleStats' type: object description: 'Report Schedule. A report schedule represents a configuration for the periodic execution of a report based on a concrete report template with concrete parameter values in scope of a given account.' required: - name - template - trigger - parameters - owner - stats reporting.ReportScheduleCreate: properties: name: type: string maxLength: 512 description: type: string nullable: true maxLength: 2048 trigger: $ref: '#/components/schemas/reporting.ReportScheduleTrigger' parameters: type: array items: type: object nullable: true renderer: type: string maxLength: 256 template: $ref: '#/components/schemas/reporting.ReportScheduleTemplateCreate' type: object description: 'Create Report Schedule. Represents an object required to be passed to create new schedule. `name` -- name of the schedule. It will be put as a report name constructed as the following string: "`schedule.name` from `Y-m-d H:i:s` (UTC)". `description` -- description of the schedule. It will be put as the description of the generated report. `trigger` -- trigger configuration of the schedule. `parameters` -- list of parameters required for the report.' required: - name - trigger - template reporting.ReportScheduleDisable: properties: notes: type: string type: object description: 'Disable Report Schedule. Is used to disable a concrete report schedule. You need to provide the `notes`, as reason for the schedule being disabled' required: - notes reporting.ReportScheduleReference: properties: id: type: string readOnly: true name: type: string maxLength: 512 type: object description: 'ReportSchedule. For scheduled reports, represents a reference to the related schedule object.' required: - name reporting.ReportScheduleStats: properties: total_executions: type: integer maximum: 2147483647 minimum: -2147483648 average_execution_time: type: integer maximum: 2147483647 minimum: -2147483648 type: object description: 'Report Schedule Stats. A report schedule stats provides information about report executions based on this schedule. `total_executions` -- total amount of report executions based on this schedule, `average_execution_time` -- average execution time of the report based on this schedule.' reporting.ReportScheduleTemplateCreate: properties: id: type: string type: object description: 'ReportSchedule template id. `id` -- id of the report template' required: - id reporting.ReportScheduleTrigger: properties: frequency: type: string enum: - daily - weekly - monthly time: type: string day_of_week: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true day_of_month: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true type: object description: 'Report Schedule Trigger details. A report schedule trigger provides information about report execution trigger. `frequency` -- frequency of the schedule, one of: `daily` | `weekly` | `monthly`. `time` -- time of the day in UTC report has to be executed (best-effort approach). `day_of_week` -- day of the week trigger is executed. 1-7: Can be null. In case if the frequency is `daily`, this is ignored. 1 - Monday, 7 - Sunday. `day_of_month` -- day of the month trigger is executed. 1-31: can be null. In case if the frequency is `daily`, this is ignored. If current month has no day number set (i.e. February has no day #31) -- report is not executed this month.' required: - frequency - time reporting.ReportScheduleUpdate: properties: name: type: string maxLength: 512 description: type: string nullable: true maxLength: 2048 trigger: $ref: '#/components/schemas/reporting.ReportScheduleTrigger' parameters: type: array items: type: object nullable: true renderer: type: string maxLength: 256 type: object required: - name - trigger reporting.ReportStatsProgress: properties: value: type: integer maximum: 2147483647 minimum: -2147483648 max: type: integer maximum: 2147483647 minimum: -2147483648 type: object description: 'Report stats. Is used to represent current (`value`) and maximum (`max`) progress of the report' required: - value - max reporting.ReportTemplate: properties: id: type: string readOnly: true name: type: string maxLength: 512 local_id: type: string maxLength: 512 description: type: string maxLength: 2048 type: type: string revision: type: integer maximum: 2147483647 minimum: -2147483648 specs_version: type: string maxLength: 32 status: type: string enum: - enabled - disabled - blocked notes: type: string nullable: true repository: $ref: '#/components/schemas/reporting.ReportTemplateRepository' audience: $ref: '#/components/schemas/reporting.ReportTemplateAudience' entrypoint: type: string maxLength: 512 parameters: type: object nullable: true owner: $ref: '#/components/schemas/reporting.AccountReference' stats: $ref: '#/components/schemas/reporting.ReportTemplateStats' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true renderers: type: object nullable: true default_renderer: type: string maxLength: 256 type: object description: 'Report Template. Is used to represent report template object.' required: - name - local_id - description - type - specs_version - repository - audience - entrypoint - owner - stats reporting.ReportTemplateAudience: properties: vendor: type: boolean provider: type: boolean type: object description: 'Report Template Audience. Is used to represent `vendor` and `provider` properties of the report template' required: - vendor - provider reporting.ReportTemplateCreate: properties: id: type: string type: object description: 'Report template id. `id` -- id of the report template' required: - id reporting.ReportTemplateNotes: properties: notes: type: string type: object description: 'Report Template Notes. Is used to disable the template. You need to provide `notes` property explaining the reason for disable action' required: - notes reporting.ReportTemplateReference: properties: id: type: string readOnly: true name: type: string maxLength: 512 description: type: string maxLength: 2048 type: type: string specs_version: type: string maxLength: 32 revision: type: integer maximum: 2147483647 minimum: -2147483648 repository: $ref: '#/components/schemas/reporting.ReportRepositoryReference' entrypoint: type: string maxLength: 512 local_id: type: string maxLength: 512 type: object description: 'Report template. Is used to represent template attached to this report' required: - name - description - type - specs_version - repository - entrypoint - local_id reporting.ReportTemplateRepository: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 512 repository_type: type: string enum: - system - custom git: $ref: '#/components/schemas/reporting.GitInfo' type: object description: 'Report Template Git. Is used to represent git repository object of the template.' required: - git reporting.ReportTemplateStats: properties: monthly_executions: type: integer readOnly: true total_executions: type: integer readOnly: true runtime_min: type: integer runtime_max: type: integer runtime_avg: type: integer wait_min: type: integer wait_max: type: integer wait_avg: type: integer success: type: integer failure: type: integer timeout: type: integer type: object description: 'Report Template Stats. Is used to represent statistics about repository. `monthly_executions` -- amount of executions in current month, `total_executions` -- amount of all executions.' required: - runtime_min - runtime_max - runtime_avg - wait_min - wait_max - wait_avg - success - failure - timeout reporting.ReportTiming: properties: run: type: string readOnly: true wait: type: string readOnly: true type: object description: 'Report timing. Is used to represent `run` and `wait` properties of the report' reporting.ReportUpdateProgress: properties: progress: $ref: '#/components/schemas/reporting.ReportStatsProgress' type: object description: 'Update report progress. Is used to update progress for a concrete report execution. You need to provide the `progress` data as input.' required: - progress reporting.ReportsRepository: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 512 description: type: string nullable: true maxLength: 2048 version: type: string nullable: true maxLength: 128 language: type: string enum: - python nullable: true repository_type: type: string enum: - system - custom revision: type: integer maximum: 2147483647 minimum: -2147483648 git: $ref: '#/components/schemas/reporting.GitInfo' status: type: string enum: - configuring - ready - failed notes: type: string nullable: true maxLength: 2048 stats: $ref: '#/components/schemas/reporting.RepoStats' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true owner: $ref: '#/components/schemas/reporting.AccountReference' type: object description: 'Repository. Is used to represent reports repository.' required: - git - stats - owner reporting.ReportsRepositoryCreate: properties: git: $ref: '#/components/schemas/reporting.GitInfoCreate' type: object description: 'Repository Create Request. Is used to represent input object to request repository creation. You need to provide `git` object with repository details.' required: - git reporting.ReportsRepositoryReference: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 512 type: object description: 'Report template repository. A repository linked to the template of this schedule.' reporting.RepositoryTags: properties: git: $ref: '#/components/schemas/reporting.GitTags' type: object description: 'Repository Tags. Is used to represent repository tags' required: - git reporting.RepositoryTagsRequest: properties: git: $ref: '#/components/schemas/reporting.GitTagsRequest' type: object description: 'Repository Tags Request. Is used to represent input object to request repository tags' required: - git slm.Account: properties: id: type: string maxLength: 16 name: type: string maxLength: 64 icon: type: string nullable: true maxLength: 2000 type: object description: Account representation. required: - id - name slm.ServiceLevelAgreement: properties: id: type: string readOnly: true owner: $ref: '#/components/schemas/slm.Account' active: type: boolean entity_type: type: string enum: - subscription_request - tier_config_request readOnly: true slos: type: array items: $ref: '#/components/schemas/slm.ServiceLevelObjective' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: Service Level Agreement representation. required: - entity_type slm.ServiceLevelIndicator: properties: id: type: string readOnly: true slo: $ref: '#/components/schemas/slm.ServiceLevelObjectiveWithSLA' entity_id: type: string maxLength: 100 zone: type: integer maximum: 2147483647 minimum: 0 days: type: string readOnly: true start_date: type: string format: date-time events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true type: object description: Service Level Indicator representation. required: - slo - entity_id - start_date slm.ServiceLevelObjective: properties: id: type: string target_status: type: string enum: - draft - pending - inquiring - revoking readOnly: true terminate: type: boolean final_action: type: string readOnly: true zones: items: properties: days: minimum: 0 type: number zone: maximum: 2 minimum: 0 type: number required: - days - zone type: object maxItems: 3 minItems: 3 type: array type: object description: Service Level Objective representation. required: - id - zones slm.ServiceLevelObjectiveWithSLA: properties: id: type: string sla: $ref: '#/components/schemas/slm.ServiceLevelAgreement' target_status: type: string enum: - draft - pending - inquiring - revoking terminate: type: boolean final_action: type: string readOnly: true zones: items: properties: days: minimum: 0 type: number zone: maximum: 2 minimum: 0 type: number required: - days - zone type: object maxItems: 3 minItems: 3 type: array type: object description: Service Level Objective with a reference to SLA representation. required: - id - sla - target_status - zones statistics.AccountTokenAggregates: properties: date: type: string format: date statuses: type: array items: $ref: '#/components/schemas/statistics.StatusCode' type: object required: - date - statuses statistics.AccountTokenSummary: properties: id: type: string readOnly: true statuses: type: array items: $ref: '#/components/schemas/statistics.Statuses' readOnly: true started_tracking_at: type: string format: date-time readOnly: true type: object statistics.Statistics: properties: id: type: string readOnly: true type: type: string enum: - account_statistics readOnly: true default: account_statistics account: type: object properties: id: type: string readOnly: true status: type: string enum: - ready - calculating readOnly: true counters: type: object properties: counter: type: object properties: value: type: integer updated: type: object properties: at: type: string format: date-time readOnly: true type: object statistics.StatusCode: properties: code: type: string count: type: integer type: object required: - code - count statistics.Statuses: properties: code: type: string readOnly: true total: type: integer readOnly: true since_last_reset: type: integer readOnly: true type: object streams.AccountReference: properties: id: type: string maxLength: 16 name: type: string maxLength: 64 icon: type: string nullable: true maxLength: 2000 type: object required: - id - name streams.Actor: properties: id: type: string name: type: string icon: type: string type: object required: - id - name - icon streams.BatchFileCreate: properties: id: type: string maxLength: 24 position: type: integer maximum: 1 minimum: 1 type: object required: - id - position streams.BatchReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - draft - processing - published - failed - deleted type: object required: - name streams.BatchUpdate: properties: external_id: type: string nullable: true maxLength: 256 description: type: string nullable: true maxLength: 2048 type: object streams.BillingBatch: properties: id: type: string readOnly: true name: type: string maxLength: 256 external_id: type: string nullable: true maxLength: 256 status: type: string enum: - draft - processing - published - failed - deleted description: type: string nullable: true maxLength: 2048 stream: $ref: '#/components/schemas/streams.BillingExtendedStreamReference' source: $ref: '#/components/schemas/streams.BatchReference' test: type: boolean error: type: string nullable: true maxLength: 1024 task: $ref: '#/components/schemas/streams.Task' stats: type: object properties: requests: type: object properties: total: type: integer processed: type: number readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string processing: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string processed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true stream_updated: type: string readOnly: true context: $ref: '#/components/schemas/streams.BillingBatchContext' type: object required: - name - stream - source - test - task - context streams.BillingBatchContext: properties: period: $ref: '#/components/schemas/streams.BillingPeriod' type: object required: - period streams.BillingBatchCreate: properties: stream: $ref: '#/components/schemas/streams.IdWrite' context: $ref: '#/components/schemas/streams.BillingBatchContext' external_id: type: string nullable: true maxLength: 256 description: type: string nullable: true maxLength: 2048 type: object required: - stream - context streams.BillingExtendedBatchReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - draft - processing - published - failed - deleted context: $ref: '#/components/schemas/streams.BillingBatchContext' type: object required: - name - context streams.BillingExtendedStreamReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - configuring - active - terminated - deleted owner: $ref: '#/components/schemas/streams.AccountReference' context: $ref: '#/components/schemas/streams.BillingStreamContext' type: object required: - name - context streams.BillingPeriod: properties: start: type: string format: date-time end: type: string format: date-time type: object required: - start - end streams.BillingStream: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - configuring - active - terminated - deleted description: type: string nullable: true maxLength: 2048 sources: type: array items: $ref: '#/components/schemas/streams._Sources' visibility: type: string enum: - private - published samples: $ref: '#/components/schemas/streams._Samples' owner: $ref: '#/components/schemas/streams.AccountReference' type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string configuring: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string activated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true validation: $ref: '#/components/schemas/streams._BatchReference' context: $ref: '#/components/schemas/streams.BillingStreamContext' type: object required: - name - context streams.BillingStreamContext: properties: account: $ref: '#/components/schemas/streams.AccountReference' product: $ref: '#/components/schemas/streams.ProductReference' marketplace: $ref: '#/components/schemas/streams.MarketplaceReference' listing: $ref: '#/components/schemas/streams.ListingReference' type: object required: - account - product - marketplace - listing streams.BillingStreamWrite: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - configuring - active - terminated - deleted description: type: string nullable: true maxLength: 2048 sources: type: array items: $ref: '#/components/schemas/streams.IdWrite' visibility: type: string enum: - private - published samples: $ref: '#/components/schemas/streams._Samples' owner: $ref: '#/components/schemas/streams.AccountReference' type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string configuring: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string activated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true validation: $ref: '#/components/schemas/streams._BatchReference' context: $ref: '#/components/schemas/streams._BillingStreamContextWrite' type: object required: - name streams.BillingTransformationRequest: properties: id: type: string readOnly: true status: type: string enum: - scheduled - pending - completed - published - failed - canceled error: type: string readOnly: true assignee: $ref: '#/components/schemas/streams.Actor' files: $ref: '#/components/schemas/streams._TransformationRequestFiles' batch: $ref: '#/components/schemas/streams.BillingExtendedBatchReference' transformation: $ref: '#/components/schemas/streams.Transformation' stream: $ref: '#/components/schemas/streams.BillingExtendedStreamReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string scheduled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string pended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string completed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string failed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string canceled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true validation: $ref: '#/components/schemas/streams.Task' stats: $ref: '#/components/schemas/streams._TransformationRequestStats' type: object required: - assignee - files - batch - transformation - stream - stats streams.Column: properties: id: type: string name: type: string maxLength: 256 type: type: string enum: - string - integer - decimal - boolean - datetime nullable: true description: type: string nullable: true maxLength: 2048 constraints: type: object nullable: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 nullable: type: boolean deprecated: true description: replaced by "required" readOnly: true required: type: boolean readOnly: true origin: $ref: '#/components/schemas/streams.TransformationReference' output: type: boolean type: object required: - id - name - origin streams.ColumnUpdate: properties: description: type: string nullable: true maxLength: 2048 gravity: type: object writeOnly: true output: type: boolean type: object streams.IdWrite: properties: id: type: string writeOnly: true type: object required: - id streams.ListingReference: properties: id: type: string maxLength: 100 type: object required: - id streams.MarketplaceReference: properties: id: type: string maxLength: 100 name: type: string maxLength: 255 icon: type: string nullable: true maxLength: 2000 currency: type: string nullable: true maxLength: 3 type: object required: - id - name streams.PriceListReference: properties: id: type: string maxLength: 100 name: type: string maxLength: 512 status: type: string enum: - draft - scheduled - active - terminated type: object required: - id - name - status streams.PriceListVersionReference: properties: id: type: string maxLength: 100 status: type: string maxLength: 16 start_at: type: string format: date-time nullable: true type: object required: - id - status streams.PricingBatch: properties: id: type: string readOnly: true name: type: string maxLength: 256 external_id: type: string nullable: true maxLength: 256 status: type: string enum: - draft - processing - published - failed - deleted description: type: string nullable: true maxLength: 2048 stream: $ref: '#/components/schemas/streams.PricingExtendedStreamReference' source: $ref: '#/components/schemas/streams.BatchReference' test: type: boolean error: type: string nullable: true maxLength: 1024 task: $ref: '#/components/schemas/streams.Task' stats: type: object properties: requests: type: object properties: total: type: integer processed: type: number readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string processing: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string processed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true stream_updated: type: string readOnly: true context: $ref: '#/components/schemas/streams.PricingBatchContext' type: object required: - name - stream - source - test - task - context streams.PricingBatchContext: properties: pricelist_version: $ref: '#/components/schemas/streams.PriceListVersionReference' type: object streams.PricingBatchCreate: properties: stream: $ref: '#/components/schemas/streams.IdWrite' context: type: string readOnly: true external_id: type: string nullable: true maxLength: 256 description: type: string nullable: true maxLength: 2048 type: object required: - stream streams.PricingExtendedBatchReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - draft - processing - published - failed - deleted context: $ref: '#/components/schemas/streams.PricingBatchContext' type: object required: - name - context streams.PricingExtendedStreamReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - configuring - active - terminated - deleted owner: $ref: '#/components/schemas/streams.AccountReference' context: $ref: '#/components/schemas/streams.PricingStreamContext' type: object required: - name - context streams.PricingStream: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - configuring - active - terminated - deleted description: type: string nullable: true maxLength: 2048 sources: type: array items: $ref: '#/components/schemas/streams._Sources' visibility: type: string enum: - private - published samples: $ref: '#/components/schemas/streams._Samples' owner: $ref: '#/components/schemas/streams.AccountReference' type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string configuring: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string activated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true validation: $ref: '#/components/schemas/streams._BatchReference' context: $ref: '#/components/schemas/streams.PricingStreamContext' type: object required: - name - context streams.PricingStreamContext: properties: account: $ref: '#/components/schemas/streams.AccountReference' product: $ref: '#/components/schemas/streams.ProductReference' marketplace: $ref: '#/components/schemas/streams.MarketplaceReference' listing: $ref: '#/components/schemas/streams.ListingReference' pricelist: $ref: '#/components/schemas/streams.PriceListReference' type: object required: - account - product - marketplace - listing - pricelist streams.PricingStreamWrite: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - configuring - active - terminated - deleted description: type: string nullable: true maxLength: 2048 sources: type: array items: $ref: '#/components/schemas/streams.IdWrite' visibility: type: string enum: - private - published samples: $ref: '#/components/schemas/streams._Samples' owner: $ref: '#/components/schemas/streams.AccountReference' type: type: string readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string configuring: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string activated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string terminated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string published: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true validation: $ref: '#/components/schemas/streams._BatchReference' context: $ref: '#/components/schemas/streams._PricingStreamContextWrite' type: object required: - name streams.PricingTransformationRequest: properties: id: type: string readOnly: true status: type: string enum: - scheduled - pending - completed - published - failed - canceled error: type: string readOnly: true assignee: $ref: '#/components/schemas/streams.Actor' files: $ref: '#/components/schemas/streams._TransformationRequestFiles' batch: $ref: '#/components/schemas/streams.PricingExtendedBatchReference' transformation: $ref: '#/components/schemas/streams.Transformation' stream: $ref: '#/components/schemas/streams.PricingExtendedStreamReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string scheduled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string pended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string completed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string failed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string canceled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true validation: $ref: '#/components/schemas/streams.Task' stats: $ref: '#/components/schemas/streams._TransformationRequestStats' type: object required: - assignee - files - batch - transformation - stream - stats streams.ProductReference: properties: id: type: string maxLength: 100 name: type: string maxLength: 255 icon: type: string nullable: true maxLength: 2000 type: object required: - id - name streams.StreamReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - configuring - active - terminated - deleted type: object required: - name streams.Task: properties: name: type: string maxLength: 128 status: type: string enum: - pending - processing - success - failed error: $ref: '#/components/schemas/streams._TaskError' type: object required: - name - error streams.Transformation: properties: id: type: string description: type: string nullable: true maxLength: 512 function: $ref: '#/components/schemas/streams.TransformationFunctionReference' overview: type: string nullable: true description: Markdown maxLength: 2000 columns: type: string readOnly: true settings: type: object nullable: true position: type: integer maximum: 2147483647 nullable: true minimum: 0 type: object required: - id - function streams.TransformationFunctionReference: properties: id: type: string readOnly: true name: type: string readOnly: true status: type: string enum: - active - decommissioned readOnly: true icon: type: string readOnly: true nullable: true manual: type: boolean readOnly: true nullable: true type: object streams.TransformationReference: properties: id: type: string type: object required: - id streams.TransformationRequest: properties: id: type: string readOnly: true status: type: string enum: - scheduled - pending - completed - published - failed - canceled error: type: string readOnly: true assignee: $ref: '#/components/schemas/streams.Actor' files: $ref: '#/components/schemas/streams._TransformationRequestFiles' batch: $ref: '#/components/schemas/streams.BatchReference' transformation: $ref: '#/components/schemas/streams.TransformationWithFunctionReference' stream: $ref: '#/components/schemas/streams.StreamReference' events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string scheduled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string pended: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string completed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string failed: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string canceled: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true validation: $ref: '#/components/schemas/streams.Task' stats: $ref: '#/components/schemas/streams._TransformationRequestStats' type: object required: - assignee - files - batch - transformation - stream - stats streams.TransformationRequestFail: properties: error: type: string nullable: true maxLength: 1024 type: object streams.TransformationRequestUpdate: properties: stats: $ref: '#/components/schemas/streams._TransformationRequestStats' files: $ref: '#/components/schemas/streams._TransformationRequestFiles' assignee: $ref: '#/components/schemas/streams.IdWrite' type: object streams.TransformationWithFunctionReference: properties: id: type: string function: $ref: '#/components/schemas/streams.TransformationFunctionReference' type: object required: - id - function streams._BatchReference: properties: id: type: string readOnly: true name: type: string maxLength: 256 status: type: string enum: - draft - processing - published - failed - deleted type: object required: - name streams._BillingStreamContextWrite: properties: account: $ref: '#/components/schemas/streams.IdWrite' product: $ref: '#/components/schemas/streams.IdWrite' marketplace: $ref: '#/components/schemas/streams.IdWrite' listing: $ref: '#/components/schemas/streams.IdWrite' type: object streams._PricingStreamContextWrite: properties: account: $ref: '#/components/schemas/streams.IdWrite' product: $ref: '#/components/schemas/streams.IdWrite' marketplace: $ref: '#/components/schemas/streams.IdWrite' listing: $ref: '#/components/schemas/streams.IdWrite' type: object streams._Samples: properties: input: type: string format: binary output: type: string format: binary readOnly: true type: object required: - input streams._Sources: properties: id: type: string name: type: string type: type: string readOnly: true status: type: string samples: $ref: '#/components/schemas/streams._Samples' readOnly: true type: object required: - id - name - status streams._TaskError: properties: message: readOnly: true type: object streams._TransformationRequestFiles: properties: input: type: string format: binary readOnly: true output: type: string format: binary type: object required: - output streams._TransformationRequestRowsStats: properties: total: type: integer readOnly: true processed: type: integer type: object required: - processed streams._TransformationRequestStats: properties: rows: $ref: '#/components/schemas/streams._TransformationRequestRowsStats' type: object required: - rows subscriptions.Account: properties: id: type: string readOnly: true name: type: string maxLength: 64 icon: type: string nullable: true maxLength: 2000 type: object required: - name subscriptions.Attribute: properties: vendor: type: object provider: type: object type: object subscriptions.BillingRequest: properties: id: type: string readOnly: true type: type: string enum: - vendor - provider events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true asset: $ref: '#/components/schemas/subscriptions.SubscriptionReference' readOnly: true items: type: array items: $ref: '#/components/schemas/subscriptions.ItemRequestReference' attributes: type: array items: $ref: '#/components/schemas/subscriptions.Attribute' period: type: object properties: from: type: string format: date-time to: type: string format: date-time delta: type: number uom: type: string enum: - monthly - yearly - years_2 - years_3 - years_4 - years_5 - years_6 readOnly: true type: object subscriptions.BillingRequestSummary: properties: id: type: string readOnly: true type: type: string enum: - vendor - provider period: type: object properties: from: type: string format: date-time to: type: string format: date-time delta: type: number uom: type: string enum: - monthly - yearly - years_2 - years_3 - years_4 - years_5 - years_6 readOnly: true type: object subscriptions.Connection: properties: id: type: string readOnly: true type: type: string enum: - test - production - preview nullable: true provider: $ref: '#/components/schemas/subscriptions.Account' readOnly: true vendor: $ref: '#/components/schemas/subscriptions.Account' hub: $ref: '#/components/schemas/subscriptions.Hub' type: object description: 'Connection Serializer that handle syndication asset representation In scope of vendor as provider returns Hyper Provider instance from syndicated data Require ''asset'' to be passed in context' subscriptions.Contract: properties: id: type: string readOnly: true name: type: string maxLength: 128 type: object required: - name subscriptions.Hub: properties: id: type: string readOnly: true name: type: string maxLength: 256 type: object required: - name subscriptions.ItemRequestReference: properties: id: type: string global_id: type: string display_name: type: string mpn: type: string item_type: type: string period: type: string quantity: type: number type: type: string billing: type: object properties: cycle_number: type: integer readOnly: true type: object required: - id - global_id - display_name - mpn - item_type - period - type subscriptions.ItemSubscriptionReference: properties: id: type: string global_id: type: string display_name: type: string mpn: type: string item_type: type: string period: type: string quantity: type: number type: type: string type: object required: - id - global_id - display_name - mpn - item_type - period - type subscriptions.ItemWithBillingSubscriptionReference: properties: id: type: string global_id: type: string display_name: type: string mpn: type: string item_type: type: string period: type: string quantity: type: number type: type: string billing: type: object properties: stats: type: object properties: vendor: type: object properties: last_request: $ref: '#/components/schemas/subscriptions.BillingRequestSummary' count: type: integer provider: type: object properties: last_request: $ref: '#/components/schemas/subscriptions.BillingRequestSummary' count: type: integer readOnly: true type: object required: - id - global_id - display_name - mpn - item_type - period - type subscriptions.Marketplace: properties: id: type: string readOnly: true name: type: string maxLength: 255 icon: type: string nullable: true maxLength: 2000 type: object required: - name subscriptions.NewBillingRequest: properties: asset_id: type: string nullable: true maxLength: 100 asset_external_uid: type: string nullable: true maxLength: 100 type: type: string enum: - vendor - provider items: type: array items: type: object attributes: $ref: '#/components/schemas/subscriptions.Attribute' period_from: type: string format: date-time period_to: type: string format: date-time period_delta: type: number minimum: 0.0 period_uom: type: string enum: - monthly - yearly - years_2 - years_3 - years_4 - years_5 - years_6 type: object required: - items - period_from - period_to - period_delta - period_uom subscriptions.Parameter: properties: id: type: string name: type: string description: type: string type: type: string value: type: string nullable: true maxLength: 2048 value_error: type: string nullable: true maxLength: 512 structured_value: type: object nullable: true type: object required: - id - name - description - type subscriptions.PendingRequest: properties: id: type: string readOnly: true type: type: string enum: - purchase - cancel - change - suspend - resume - adjustment - renew status: type: string enum: - draft - tiers_setup - pending - inquiring - approved - failed - scheduled - revoking - revoked template: $ref: '#/components/schemas/subscriptions.TemplateReference' type: object required: - template subscriptions.Product: properties: id: type: string readOnly: true name: type: string maxLength: 255 status: type: string maxLength: 30 icon: type: string maxLength: 2000 type: object required: - name - status subscriptions.Subscription: properties: id: type: string readOnly: true status: type: string enum: - draft - processing - active - terminating - suspended - terminated readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true external_id: type: string readOnly: true nullable: true external_uid: type: string readOnly: true nullable: true product: $ref: '#/components/schemas/subscriptions.Product' connection: $ref: '#/components/schemas/subscriptions.Connection' readOnly: true items: type: array items: $ref: '#/components/schemas/subscriptions.ItemWithBillingSubscriptionReference' params: type: array items: $ref: '#/components/schemas/subscriptions.Parameter' tiers: type: object properties: customer: $ref: '#/components/schemas/subscriptions.TierAccount' tier1: $ref: '#/components/schemas/subscriptions.TierAccount' tier2: $ref: '#/components/schemas/subscriptions.TierAccount' readOnly: true marketplace: $ref: '#/components/schemas/subscriptions.Marketplace' readOnly: true contract: $ref: '#/components/schemas/subscriptions.Contract' readOnly: true billing: type: object properties: period: type: object properties: delta: type: number uom: type: string enum: - monthly - yearly - years_2 - years_3 - years_4 - years_5 - years_6 next_date: type: string format: date-time anniversary: type: object properties: day: type: integer month: type: integer stats: type: object properties: vendor: type: object properties: last_request: $ref: '#/components/schemas/subscriptions.BillingRequestSummary' count: type: integer provider: type: object properties: last_request: $ref: '#/components/schemas/subscriptions.BillingRequestSummary' count: type: integer readOnly: true template: $ref: '#/components/schemas/subscriptions.TemplateReference' pending_request: $ref: '#/components/schemas/subscriptions.PendingRequest' renewal_expiration_date: type: string format: date-time readOnly: true nullable: true type: object required: - template - pending_request subscriptions.SubscriptionReference: properties: id: type: string readOnly: true status: type: string enum: - draft - processing - active - terminating - suspended - terminated readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true external_id: type: string readOnly: true nullable: true external_uid: type: string readOnly: true nullable: true product: $ref: '#/components/schemas/subscriptions.Product' connection: $ref: '#/components/schemas/subscriptions.Connection' readOnly: true params: type: array items: $ref: '#/components/schemas/subscriptions.Parameter' tiers: type: object properties: customer: $ref: '#/components/schemas/subscriptions.TierAccount' tier1: $ref: '#/components/schemas/subscriptions.TierAccount' tier2: $ref: '#/components/schemas/subscriptions.TierAccount' readOnly: true marketplace: $ref: '#/components/schemas/subscriptions.Marketplace' readOnly: true contract: $ref: '#/components/schemas/subscriptions.Contract' readOnly: true billing: type: object properties: period: type: object properties: delta: type: number uom: type: string enum: - monthly - yearly - years_2 - years_3 - years_4 - years_5 - years_6 next_date: type: string format: date-time anniversary: type: object properties: day: type: integer month: type: integer readOnly: true renewal_expiration_date: type: string format: date-time readOnly: true nullable: true type: object subscriptions.Subscriptions: properties: id: type: string readOnly: true status: type: string enum: - draft - processing - active - terminating - suspended - terminated readOnly: true events: type: object properties: created: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string updated: type: object properties: at: type: string format: datetime by: type: object properties: id: type: string name: type: string icon: type: string readOnly: true external_id: type: string readOnly: true nullable: true external_uid: type: string readOnly: true nullable: true product: $ref: '#/components/schemas/subscriptions.Product' connection: $ref: '#/components/schemas/subscriptions.Connection' readOnly: true items: type: array items: $ref: '#/components/schemas/subscriptions.ItemSubscriptionReference' params: type: array items: $ref: '#/components/schemas/subscriptions.Parameter' tiers: type: object properties: customer: $ref: '#/components/schemas/subscriptions.TierAccount' tier1: $ref: '#/components/schemas/subscriptions.TierAccount' tier2: $ref: '#/components/schemas/subscriptions.TierAccount' readOnly: true marketplace: $ref: '#/components/schemas/subscriptions.Marketplace' readOnly: true contract: $ref: '#/components/schemas/subscriptions.Contract' readOnly: true billing: type: object properties: period: type: object properties: delta: type: number uom: type: string enum: - monthly - yearly - years_2 - years_3 - years_4 - years_5 - years_6 next_date: type: string format: date-time anniversary: type: object properties: day: type: integer month: type: integer readOnly: true template: $ref: '#/components/schemas/subscriptions.TemplateReference' pending_request: $ref: '#/components/schemas/subscriptions.PendingRequest' renewal_expiration_date: type: string format: date-time readOnly: true nullable: true type: object required: - template - pending_request subscriptions.TemplateReference: properties: id: type: string readOnly: true name: type: string maxLength: 255 type: object required: - name subscriptions.TierAccount: properties: id: type: string readOnly: true external_id: type: string readOnly: true nullable: true external_uid: type: string readOnly: true nullable: true name: type: string readOnly: true tax_id: type: string readOnly: true nullable: true contact_info: type: object 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 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 required: - first_name - last_name - email - phone_number required: - address_line1 - city - postal_code - country - contact readOnly: true type: object usage.Categories: properties: id: type: string name: type: string maxLength: 255 description: type: string nullable: true maxLength: 255 type: object required: - id - name usage.PartUsageFile: properties: id: type: string readOnly: true status: type: string enum: - draft - ready - closed - failed readOnly: true outdated: type: boolean readOnly: true usagefile: $ref: '#/components/schemas/usage.ReferenceUsageFile' binding: $ref: '#/components/schemas/usage.ReferenceBinding' marketplace: $ref: '#/components/schemas/usage.ReferenceMarketplace' error: type: object properties: detail: type: string readOnly: true events: type: object properties: created: $ref: '#/components/schemas/usage.UsageEvents' uploaded: $ref: '#/components/schemas/usage.UsageEvents' submitted: $ref: '#/components/schemas/usage.UsageEvents' accepted: $ref: '#/components/schemas/usage.UsageEvents' closed: $ref: '#/components/schemas/usage.UsageEvents' rejected: $ref: '#/components/schemas/usage.UsageEvents' deleted: $ref: '#/components/schemas/usage.UsageEvents' stats: type: object properties: uploaded: type: integer validated: type: integer pending: type: integer accepted: type: integer closed: type: integer billed: type: integer readOnly: true provider: $ref: '#/components/schemas/usage.ReferenceAccount' external_id: type: string type: object required: - external_id usage.Products: properties: id: type: string nullable: true maxLength: 100 name: type: string nullable: true maxLength: 255 icon: type: string nullable: true maxLength: 255 type: object usage.Reconciliation: properties: id: type: string readOnly: true status: type: string enum: - uploaded - processing - processed - failed nullable: true usagefile: $ref: '#/components/schemas/usage.ReferenceUsageFile' partusagefile: $ref: '#/components/schemas/usage.ReferencePartUsageFile' binding: $ref: '#/components/schemas/usage.ReferenceBinding' error: type: object properties: detail: type: string readOnly: true notes: type: object properties: uploaded: type: string processing: type: string readOnly: true events: type: object properties: created: $ref: '#/components/schemas/usage.UsageEvents' uploaded: $ref: '#/components/schemas/usage.UsageEvents' submitted: $ref: '#/components/schemas/usage.UsageEvents' accepted: $ref: '#/components/schemas/usage.UsageEvents' closed: $ref: '#/components/schemas/usage.UsageEvents' rejected: $ref: '#/components/schemas/usage.UsageEvents' deleted: $ref: '#/components/schemas/usage.UsageEvents' type: object usage.ReferenceAccount: properties: id: type: string maxLength: 100 name: type: string nullable: true maxLength: 255 icon: type: string nullable: true maxLength: 2000 type: object required: - id usage.ReferenceAsset: properties: id: type: string maxLength: 255 external_id: type: string nullable: true maxLength: 255 external_uid: type: string nullable: true maxLength: 255 type: object description: Serialize reference asset object required: - id usage.ReferenceBinding: properties: hub: $ref: '#/components/schemas/usage.ReferenceHub' external_id: type: string readOnly: true type: object usage.ReferenceContract: properties: id: type: string maxLength: 100 name: type: string nullable: true maxLength: 255 type: object required: - id usage.ReferenceHub: properties: id: type: string maxLength: 255 name: type: string nullable: true maxLength: 255 type: object required: - id usage.ReferenceItem: properties: id: type: string local_id: type: string nullable: true maxLength: 128 name: type: string maxLength: 255 unit: type: string nullable: true maxLength: 64 mpn: type: string nullable: true precision: type: string readOnly: true type: type: string readOnly: true type: object description: Serialize reference item object required: - id - name usage.ReferenceMarketplace: properties: id: type: string maxLength: 100 name: type: string nullable: true maxLength: 255 icon: type: string nullable: true maxLength: 500 type: object required: - id usage.ReferencePartUsageFile: properties: id: type: string readOnly: true provider: $ref: '#/components/schemas/usage.ReferenceAccount' type: object required: - provider usage.ReferenceUsageFile: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 100 schema: type: string enum: - tr - pr - qt - cr currency: type: string nullable: true maxLength: 20 type: object usage.ReferenceUser: properties: id: type: string name: type: string type: object required: - id - name usage.UsageEvents: properties: at: type: string format: date-time by: $ref: '#/components/schemas/usage.ReferenceUser' type: object required: - at usage.UsageFileCreate: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 100 external_id: type: string vendor: type: string nullable: true provider: type: string nullable: true environment: type: string enum: - test - preview - production marketplace: type: string nullable: true distribution_contract: type: string nullable: true product_id: type: string nullable: true maxLength: 100 product_name: type: string nullable: true maxLength: 255 product_icon: type: string description: type: string nullable: true maxLength: 200 schema: type: string enum: - tr - pr - qt - cr currency: type: string start_datetime_utc: type: string format: date-time nullable: true end_datetime_utc: type: string format: date-time nullable: true type: object usage.UsageFileDetail: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 100 external_id: type: string status: type: string enum: - draft - uploading - uploaded - invalid - processing - ready - rejected - pending - accepted - closed - deleted vendor: $ref: '#/components/schemas/usage.ReferenceAccount' provider: $ref: '#/components/schemas/usage.ReferenceAccount' environment: type: string enum: - test - preview - production marketplace: $ref: '#/components/schemas/usage.ReferenceMarketplace' contract: $ref: '#/components/schemas/usage.ReferenceContract' product: $ref: '#/components/schemas/usage.Products' error_detail: type: string nullable: true maxLength: 200 description: type: string nullable: true maxLength: 200 acceptance_note: type: string nullable: true maxLength: 200 rejection_note: type: string nullable: true maxLength: 200 schema: type: string enum: - tr - pr - qt - cr currency: type: string nullable: true maxLength: 20 period: type: object properties: from: type: string format: date to: type: string format: date stats: type: object properties: uploaded: type: integer validated: type: integer pending: type: integer accepted: type: integer closed: type: integer billed: type: integer readOnly: true events: type: object properties: created: $ref: '#/components/schemas/usage.UsageEvents' uploaded: $ref: '#/components/schemas/usage.UsageEvents' submitted: $ref: '#/components/schemas/usage.UsageEvents' accepted: $ref: '#/components/schemas/usage.UsageEvents' closed: $ref: '#/components/schemas/usage.UsageEvents' rejected: $ref: '#/components/schemas/usage.UsageEvents' deleted: $ref: '#/components/schemas/usage.UsageEvents' sub_status: type: string enum: - processing - processed nullable: true usage_file_uri: type: string readOnly: true processed_file_uri: type: string readOnly: true reconciliation_file_uri: type: string readOnly: true records: type: object properties: valid: type: integer invalid: type: integer closed: type: integer readOnly: true start_datetime_utc: type: string format: date-time writeOnly: true end_datetime_utc: type: string format: date-time writeOnly: true type: object required: - external_id - vendor - provider - marketplace - contract usage.UsageFileList: properties: id: type: string readOnly: true name: type: string nullable: true maxLength: 100 external_id: type: string status: type: string enum: - draft - uploading - uploaded - invalid - processing - ready - rejected - pending - accepted - closed - deleted vendor: $ref: '#/components/schemas/usage.ReferenceAccount' provider: $ref: '#/components/schemas/usage.ReferenceAccount' environment: type: string enum: - test - preview - production marketplace: $ref: '#/components/schemas/usage.ReferenceMarketplace' contract: $ref: '#/components/schemas/usage.ReferenceContract' product: $ref: '#/components/schemas/usage.Products' error_detail: type: string nullable: true maxLength: 200 description: type: string nullable: true maxLength: 200 acceptance_note: type: string nullable: true maxLength: 200 rejection_note: type: string nullable: true maxLength: 200 schema: type: string enum: - tr - pr - qt - cr currency: type: string nullable: true maxLength: 20 period: type: object properties: from: type: string format: date to: type: string format: date stats: type: object properties: uploaded: type: integer validated: type: integer pending: type: integer accepted: type: integer closed: type: integer billed: type: integer readOnly: true events: type: object properties: created: $ref: '#/components/schemas/usage.UsageEvents' uploaded: $ref: '#/components/schemas/usage.UsageEvents' submitted: $ref: '#/components/schemas/usage.UsageEvents' accepted: $ref: '#/components/schemas/usage.UsageEvents' closed: $ref: '#/components/schemas/usage.UsageEvents' rejected: $ref: '#/components/schemas/usage.UsageEvents' deleted: $ref: '#/components/schemas/usage.UsageEvents' type: object required: - external_id - vendor - provider - marketplace - contract usage.UsageFileUpdate: properties: description: type: string nullable: true maxLength: 200 note: type: string nullable: true maxLength: 200 external_id: type: string nullable: true maxLength: 200 type: object usage.UsageItemRule: properties: id: type: string readOnly: true action: type: string enum: - accept - reject - manual scope: type: string rule: type: string nullable: true maxLength: 2000 status: type: string enum: - active - deleted item: $ref: '#/components/schemas/usage.UsageRuleReferenceItem' events: type: object properties: created: $ref: '#/components/schemas/usage.UsageEvents' updated: $ref: '#/components/schemas/usage.UsageEvents' readOnly: true item_id: type: string writeOnly: true item_name: type: string writeOnly: true product_id: type: string writeOnly: true account_id: type: string writeOnly: true created_by: type: string writeOnly: true updated_by: type: string writeOnly: true type: object usage.UsageRecord: properties: id: type: string readOnly: true start_date: type: string format: date-time readOnly: true end_date: type: string format: date-time readOnly: true product_id: type: string nullable: true maxLength: 500 external_billing_id: type: string readOnly: true external_billing_note: type: string readOnly: true item: $ref: '#/components/schemas/usage.ReferenceItem' asset: $ref: '#/components/schemas/usage.ReferenceAsset' category: type: string readOnly: true tier: type: integer maximum: 2147483647 nullable: true minimum: 0 amount: type: number maximum: 10000000000000000 minimum: -10000000000000000 nullable: true multiplier: type: integer maximum: 2147483647 minimum: -2147483648 usage: type: number status: type: string enum: - valid - invalid - approved - rejected - closed nullable: true closed_at: type: string format: date-time nullable: true closed_by: type: string nullable: true maxLength: 254 params: type: array items: $ref: '#/components/schemas/usage.UsageRecordParameters' item_id: type: string readOnly: true asset_id: type: string readOnly: true usagefile: $ref: '#/components/schemas/usage.ReferenceUsageFile' resource_local_id: type: string readOnly: true asset_external_id: type: string readOnly: true asset_external_uid: type: string readOnly: true type: object required: - usage - usagefile usage.UsageRecordAggregate: properties: item: $ref: '#/components/schemas/usage.ReferenceItem' asset: $ref: '#/components/schemas/usage.ReferenceAsset' amount: type: number maximum: 10000000000000000 minimum: -10000000000000000 nullable: true currency: type: string nullable: true maxLength: 100 consumed: type: integer readOnly: true accepted: type: integer readOnly: true events: type: object properties: last_reported: $ref: '#/components/schemas/usage.UsageEvents' readOnly: true type: object description: Serializer class for UsageRecordAggregate API required: - item - asset usage.UsageRecordParameters: properties: parameter_name: type: string maxLength: 255 parameter_value: type: string nullable: true maxLength: 255 type: object required: - parameter_name usage.UsageRuleReferenceItem: properties: id: type: string readOnly: true name: type: string readOnly: true type: object responses: any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' auth.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' branding.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' conversations.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' custom.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' dp.create_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' dp.update_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' eaas.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' helpdesk.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' localization.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' media.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' ns.create_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' ns.update_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' offers.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' pim.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' pricing.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' reporting.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' slm.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' statistics.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' streams.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' subscriptions.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' usage.any_400: content: application/json: schema: type: object properties: error_code: type: string errors: type: array items: type: string description: '' parameters: RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer auth.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer auth.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer auth.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer auth.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer branding.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer branding.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer conversations.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer conversations.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer custom.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer custom.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp.CategoriesPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp.CategoriesPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp.LimitOffsetContentRangePagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp.LimitOffsetContentRangePagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp.MySQLandRQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp.MySQLandRQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp.PartnersPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp.PartnersPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp.ProductConfigurationDataPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp.ProductConfigurationDataPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer dp._ParamsPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer dp._ParamsPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer eaas.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer eaas.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer helpdesk.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer helpdesk.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer localization.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer localization.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer media.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer media.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer ns.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer ns.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer offers.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer offers.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer pim.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer pim.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer pricing.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer pricing.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer reporting.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer reporting.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer slm.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer slm.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer streams.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer streams.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer subscriptions.RQLContentRangeLimitOffsetPagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer subscriptions.RQLContentRangeLimitOffsetPagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer usage.RQL1000Pagination.limit: name: limit required: false in: query description: Number of results to return per page. schema: type: integer usage.RQL1000Pagination.offset: name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer examples: LeadsCreateExample: summary: Lead request description: Request body needed to create a new **Lead** object. value: name: My Lead listing: id: LST-065-002-002 data: name: Jonathan email: jpaul@rios.com country_code: ES LeadsDetailedResponseExample: summary: Lead response description: This is a representation of a **Lead** object including the Lead Data. value: id: LDR-123-345-345 name: My lead distributor: id: PA-000-000 name: JPaul Gold icon: some vendor: id: VA-000-000 name: JPaul Platinum icon: some status: pending form: id: LDF-1460-7899 name: Custom form for marketplace XX owner: id: VA-000-000 name: JPaul Platinum icon: some status: active template: custom listing: id: LST-065-002-002 product: id: PRD-000-065-002 name: Product 002 for JPaul Platinum icon: some marketplace: id: MP-1234-1234 name: MP 1234 icon: some provider: id: PA-000-000 name: JPaul Gold data: name: Jonathan email: jpaul@rios.com country_code: ES events: created: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 updated: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 deleted: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 note: status change reason LeadsFormCreateExample-custom_template: summary: Lead Form request custom template description: Request body needed to create a new **Lead Form** object using a custom template. value: name: Custom form for marketplace XX template: custom schema: - id: name type: text title: Name required: true LeadsFormCreateExample-default_template: summary: Lead Form request default template description: Request body needed to create a new **Lead Form** object using the default template. value: name: Form for marketplace XX template: default LeadsFormDetailedResponseExample: summary: Lead Form response description: This is a detailed representation of a **LeadForm**. value: id: LDF-1460-7899 name: Custom form for marketplace XX owner: id: VA-000-000 name: JPaul Platinum status: active template: custom schema: - id: name type: text title: Name required: true events: created: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 updated: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 listings: - LST-123-123-123 LeadsFormDetailedResponseExample-list: summary: Lead Form response description: This is a detailed representation of a **LeadForm**. value: - id: LDF-1460-7899 name: Custom form for marketplace XX owner: id: VA-000-000 name: JPaul Platinum status: active template: custom schema: - id: name type: text title: Name required: true events: created: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 updated: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 listings: - LST-123-123-123 LeadsFormResponseExample: summary: Lead Form response description: This is a representation of a **LeadForm**. value: id: LDF-1460-7899 name: Custom form for marketplace XX owner: id: VA-000-000 name: JPaul Platinum status: active template: custom schema: - id: name type: text title: Name required: true events: created: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 updated: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 LeadsFormUpdateExample: summary: Lead Form request description: Request body used to update an existing **Lead Form** object, with all supported fields. value: name: New name for custom form for marketplace XX template: custom schema: - id: name type: text title: Name required: true LeadsInvalidateExample: summary: Lead request description: Optional request body to specify a note when invalidating a **Lead** object. value: note: invalidating notes LeadsQualifyExample: summary: Lead request description: Optional request body to specify a note when qualifying a **Lead** object. value: note: qualifying notes LeadsResponseExample: summary: Lead response description: This is a representation of a **Lead** object, excluding the Lead Data. value: id: LDR-123-345-345 name: My lead distributor: id: PA-000-000 name: JPaul Gold icon: some vendor: id: VA-000-000 name: JPaul Platinum icon: some status: pending form: id: LDF-1460-7899 name: Custom form for marketplace XX owner: id: VA-000-000 name: JPaul Platinum icon: some status: active template: custom listing: id: LST-065-002-002 product: id: PRD-000-065-002 name: Product 002 for JPaul Platinum icon: some marketplace: id: MP-1234-1234 name: MP 1234 icon: some provider: id: PA-000-000 name: JPaul Gold icon: some events: created: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 updated: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 note: status change reason LeadsResponseExample-list: summary: Lead response description: This is a representation of a **Lead** object, excluding the Lead Data. value: - id: LDR-123-345-345 name: My lead distributor: id: PA-000-000 name: JPaul Gold icon: some vendor: id: VA-000-000 name: JPaul Platinum icon: some status: pending form: id: LDF-1460-7899 name: Custom form for marketplace XX owner: id: VA-000-000 name: JPaul Platinum icon: some status: active template: custom listing: id: LST-065-002-002 product: id: PRD-000-065-002 name: Product 002 for JPaul Platinum icon: some marketplace: id: MP-1234-1234 name: MP 1234 icon: some provider: id: PA-000-000 name: JPaul Gold icon: some events: created: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 updated: at: '2023-12-14T06:00:51+00:00' by: id: UR-065-000-003 note: status change reason ListingFormUpdateExample: summary: Listing Form request description: Request body used to set the **Lead Form** of a **Listing** object. value: id: LDF-000-000-000 ListingLeadsCreateExample: summary: Lead request description: Request body needed to create a new **Lead** object. Note that listing is not specified here, because it is taken from the JWT. value: name: My Lead data: name: Jonathan email: jpaul@rios.com country_code: ES ListingLeadsCreateResponseExample: summary: Lead embed response description: This is a response of a **Lead** object, including only the Id. value: id: LDR-123-345-345 ListingLeadsFormResponseExample: summary: Lead Form embed response description: This is a representation of a **LeadForm**, including only the Id and Schema value: id: LDF-1460-7899 schema: - id: name type: text title: Name required: true ModuleSettingsResponseExample: summary: Module settings response description: Key pair information for the current account value: jwt: kid: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX private_key: '{private key}' iss: /leads/PA-000-000 aud: /embed/leads/PA-000-000 conversations.Conversation: summary: Conversation Object description: The example is a full representation of a **Conversation** object value: id: CO-716-846-575-885-101-001 instance_id: CA-594-965-699 topic: 'Case: CA-594-965-699' type: conversation status: open events: created: at: '2021-11-16T08:45:33+00:00' by: id: SU-364-361-248 name: John Doe updated: at: '2021-11-16T08:45:33+00:00' by: id: SU-364-361-248 name: John Doe accounts: - id: VA-521-964 name: ACME Inc. - id: PA-218-422 name: CORP Inc. icon: /media/PA-218-422/media/icon_A6agTP9.png creator: id: SU-364-361-248 name: John Doe created: '2021-11-16T08:45:33+00:00' conversations.Conversation-list: summary: Conversation Object description: The example is a full representation of a **Conversation** object value: - id: CO-716-846-575-885-101-001 instance_id: CA-594-965-699 topic: 'Case: CA-594-965-699' type: conversation status: open events: created: at: '2021-11-16T08:45:33+00:00' by: id: SU-364-361-248 name: John Doe updated: at: '2021-11-16T08:45:33+00:00' by: id: SU-364-361-248 name: John Doe accounts: - id: VA-521-964 name: ACME Inc. - id: PA-218-422 name: CORP Inc. icon: /media/PA-218-422/media/icon_A6agTP9.png creator: id: SU-364-361-248 name: John Doe created: '2021-11-16T08:45:33+00:00' conversations.CreateMessage-new_conv_message: summary: Post new message for the conversation value: text: Hi, I am working on it. conversations.CreateMessage-new_conv_private_message: summary: Post new **private** message for the conversation value: text: Guys, please check user USR198882 on server ADCORP1 type: private conversations.CreateMessage-new_conv_state_change_message: summary: Post new **state change** message for the conversation value: text: Changing to resolved (John). I have verified everything type: state_change conversations.Message: summary: Message Object description: The example is a full representation of a **Message** object value: id: ME-492-157-092-420-525-352 conversation: CO-282-049-455-089-453-289 account: id: VA-521-964 name: ACME Inc. created: '2021-11-16T12:08:01+00:00' creator: id: UR-630-250-903 name: John Doe text: Hi, the status of the request has been changed. type: message events: created: at: '2021-11-16T12:08:01+00:00' by: id: UR-630-250-903 name: John Doe updated: at: '2021-11-16T12:08:01+00:00' conversations.Message-list: summary: Message Object description: The example is a full representation of a **Message** object value: - id: ME-492-157-092-420-525-352 conversation: CO-282-049-455-089-453-289 account: id: VA-521-964 name: ACME Inc. created: '2021-11-16T12:08:01+00:00' creator: id: UR-630-250-903 name: John Doe text: Hi, the status of the request has been changed. type: message events: created: at: '2021-11-16T12:08:01+00:00' by: id: UR-630-250-903 name: John Doe updated: at: '2021-11-16T12:08:01+00:00' conversations.UpdateMessage-update_conv_message: summary: Update message text value: text: Hi, I am working on it. conversations.UpdateMessage-update_conv_private_message: summary: Update message text and type value: text: Guys, please check user USR198882 on server ADCORP1 type: private custom.CustomAttributeDetailedResponseExample: summary: Custom Attribute detailed response description: This is a detailed representation of a **Custom Attribute**. value: data: string: value int: 1 dict: foo: bar list: - 1 - 2 - 3 - '4' - 5.6 owner: id: PA-000-000 name: Distributor events: created: at: '2024-08-13T14:55:29+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T14:56:23+00:00' by: id: UR-002-001-000 name: Another custom.CustomAttributeHistoryListResponseExample-list: summary: Custom Attribute History list response description: This is the list representation of **Custom Attributes History**. value: - - data: string: value int: 1 dict: foo: bar list: - 1 - 2 - 3 - '4' - 5.6 owner: id: PA-000-000 name: Distributor events: created: at: '2024-08-13T14:55:29+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T14:56:23+00:00' by: id: UR-002-001-000 name: Another - data: test: some owner: id: PA-000-000 name: Distributor events: created: at: '2024-08-13T15:09:30+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T15:09:30+00:00' by: id: UR-002-001-000 name: Another custom.CustomAttributeItemsListResponseExample-list: summary: Custom Attribute list response description: This is the list representation of **Custom Attributes**. value: - - data: string: value int: 1 dict: foo: bar list: - 1 - 2 - 3 - '4' - 5.6 object: id: PRD-123-123-123-00001 owner: id: PA-000-000 name: Distributor events: created: at: '2024-08-13T14:55:29+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T14:56:23+00:00' by: id: UR-002-001-000 name: Another - data: test: some owner: id: VA-000-000 name: Vendor object: id: PRD-123-123-123-00002 events: created: at: '2024-08-13T15:09:30+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T15:09:30+00:00' by: id: UR-002-001-000 name: Another custom.CustomAttributeListResponseExample-list: summary: Custom Attribute list response description: This is the list representation of **Custom Attributes**. value: - - data: string: value int: 1 dict: foo: bar list: - 1 - 2 - 3 - '4' - 5.6 owner: id: PA-000-000 name: Distributor events: created: at: '2024-08-13T14:55:29+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T14:56:23+00:00' by: id: UR-002-001-000 name: Another - data: test: some owner: id: VA-000-000 name: Vendor events: created: at: '2024-08-13T15:09:30+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T15:09:30+00:00' by: id: UR-002-001-000 name: Another custom.MetadataCaResponseExample: summary: Custom Attribute metadata detailed response description: This is a detailed representation of a **Custom Attribute** metadata. value: restrictions: owner: - field1 - field3 owner: id: PA-000-000 name: Distributor events: created: at: '2024-08-13T14:55:29+00:00' by: id: UR-002-001-001 name: User updated: at: '2024-08-13T14:56:23+00:00' by: id: UR-002-001-000 name: Another custom.MetadataCaUpdateRequestExample: summary: Custom Attribute request description: Request body needed to update metadata for a **Custom Attribute** object. value: restrictions: owner: - field_only_visible_for_owner custom.UpsertCustomAttributeRequestExample: summary: Custom Attribute request description: Request body needed to create/update a new **Custom Attribute** object. value: data: name: Jonathan email: jpaul@rios.com country_code: ES eaas.CatalogRequestPublishRequest: summary: Publish description: '' value: comment: Take into account my comment! eaas.CatalogRequestUnpublishRequest: summary: Unpublish description: '' value: comment: Take into account my comment! eaas.CreateInvitationRequest: summary: invitation description: '' value: title: Invitation for Jose environment: id: ENV-1234-1234-03 type: production eaas.CreateInvitationResponse: summary: invitation description: '' value: id: TLI-209-045 title: Invitation for Jose code: aa691621eaf8fa96a4a28ed8f88a8148efabcdf environment: id: ENV-1234-1234-03 type: production extension: id: SRVC-1234-1234 name: Extension name owner: id: VA-123-000 name: Vendor account 123 role: vendor extension_id: EXT-333-444 status: invited events: created: at: '2022-11-09T10:15:41+00:00' by: id: UR-123-000-003 name: Pepe updated: at: '2022-11-09T10:15:41+00:00' by: id: UR-123-000-003 name: Pepe eaas.CreateLogSettingRequest: summary: log setting description: '' value: tenant_id: b1d64181-e33e-4f1f-2dc4-ebff99a16152 client_id: b1d64181-e33e-4f1f-2dc4-ebff99a16153 client_secret: rG8kQ~Ti-wlzP1Enykk44O_6igM3~2JefUYgd storage_account: accountname container: mycontainer eaas.CreateScheduleRequest-advanced: summary: Create advanced schedule value: method: approve_regular_request_purchase name: PR Approve description: Scheduled approval for regular purchase requests. parameter: input: data some: value trigger: type: advanced cron_expression: 0 */2 * * * start: '2021-12-15T00:00:00+00:00' eaas.CreateScheduleRequest-onetime: summary: Create onetime schedule value: method: approve_regular_request_purchase name: PR Approve description: Scheduled approval for regular purchase requests. parameter: input: data some: value trigger: type: onetime date: '2021-12-15T00:00:00+00:00' eaas.CreateScheduleRequest-recurring: summary: Create recurring schedule value: method: approve_regular_request_purchase name: PR Approve description: Scheduled approval for regular purchase requests. parameter: input: data some: value trigger: type: recurring unit: days amount: 2 start: '2021-12-15T00:00:00+00:00' eaas.CreateServiceRequest-distributor: summary: Create a new hub extension (distributors). value: icon: service_icon name: FallBall for business extension type: hub description: FallBall for business subscriptions fulfillment management. hub: id: HB-0000 eaas.CreateServiceRequest-multiaccount: summary: Create a new multi-account extension. value: icon: service_icon name: FallBall for business extension description: FallBall for business subscriptions fulfillment management. type: multiaccount package_id: com.cloudblue.extension-001 eaas.CreateServiceRequest-transformations: summary: Create a new transformations extension. value: icon: service_icon name: FallBall for business extension description: FallBall for manage transformations. type: transformations package_id: com.cloudblue.transformations eaas.CreateServiceRequest-vendor: summary: Create a new fullfilment extension (vendors). value: icon: service_icon name: FallBall for business extension type: products description: FallBall for business subscriptions fulfillment management. product: id: PRD-440-256-612 eaas.CreateVariableRequest: summary: With auth description: '' value: name: auth_token value: 3f3f3f3f3f3f3f3f3 secure: true eaas.EnvironmentLogsResponse: summary: Environment logs entries. description: Example of logs entries for a **cloud** environment. value: id: ENV-4400-0874-01 type: development runtime: cloud logs: - timestamp: '2021-10-20T16:35:02.336Z' log_level: INFO message: Received event for request PR-9654-2758-5816-001 in status pending - timestamp: '2021-10-20T16:35:02.073Z' log_level: ERROR message: Unhandled exception during execution of task TQ-3504-3622-8976-6708 - timestamp: '2021-10-20T16:35:01.913Z' log_level: INFO message: request_id=PR-9654-2758-5816-001 - template_id= - timestamp: '2021-10-20T16:35:01.912Z' log_level: INFO message: Updating fulfillment parameters as follows:param_a to skhfilrsab and param_b to xycrlc - timestamp: '2021-10-20T16:35:01.360Z' log_level: INFO message: Received event for request PR-9654-2758-5816-001 in status pending eaas.EnvironmentResponse: summary: Environment object. description: The example is a full representation of the **Environment** object. value: id: ENV-4400-0874-01 type: development runtime: cloud external_id: 61649846-b931-4572-8304-43a301f82738 git: url: https://github.com/cloudblue/eaas-e2e-mock.git tag: '24.0' commit: 45d81a8543e6a8794e0b15192978f281d710f6bf readme_url: https://github.com/cloudblue/eaas-e2e-mock/blob/master/README.md changelog_url: https://github.com/cloudblue/eaas-e2e-mock/blob/master/CHANGELOG.md capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: false approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: false approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: false approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true scheduled: true revoking: true revoked: true - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: true category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: true category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false schedulables: - name: Schedulable method mock method: execute_scheduled_processing description: It can be used to test DevOps scheduler. resources: cpu: 1 memory: 1 configuration: TIER_REQUEST_APPROVE_TEMPLATE_ID: ASSET_REQUEST_CHANGE_TEMPLATE_ID: ASSET_REQUEST_APPROVE_TEMPLATE_ID: configuration_changed: false jwt_secret: JWT-9cbfcbcc-3518496a-ae1b9dc0-79df99bc instances: - id: INS-4400-0874-01-000001 runtime: cloud status: connected events: created: at: '2021-10-20T14:52:34.975326Z' status: running log_level: ERROR features: event_processing_available: true custom_api_available: true web_app_available: true anvil_app_available: true transformation_app_available: true eaas.EnvironmentResponse-list: summary: Environment object. description: The example is a full representation of the **Environment** object. value: - id: ENV-4400-0874-01 type: development runtime: cloud external_id: 61649846-b931-4572-8304-43a301f82738 git: url: https://github.com/cloudblue/eaas-e2e-mock.git tag: '24.0' commit: 45d81a8543e6a8794e0b15192978f281d710f6bf readme_url: https://github.com/cloudblue/eaas-e2e-mock/blob/master/README.md changelog_url: https://github.com/cloudblue/eaas-e2e-mock/blob/master/CHANGELOG.md capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: false approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: false approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: false approved: true failed: true scheduled: true revoking: true revoked: true - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true scheduled: true revoking: true revoked: true - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: true statuses: draft: false tiers_setup: false pending: true inquiring: true approved: true failed: true - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: true statuses: draft: true tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: true category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: true category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false schedulables: - name: Schedulable method mock method: execute_scheduled_processing description: It can be used to test DevOps scheduler. resources: cpu: 1 memory: 1 configuration: TIER_REQUEST_APPROVE_TEMPLATE_ID: ASSET_REQUEST_CHANGE_TEMPLATE_ID: ASSET_REQUEST_APPROVE_TEMPLATE_ID: configuration_changed: false jwt_secret: JWT-9cbfcbcc-3518496a-ae1b9dc0-79df99bc instances: - id: INS-4400-0874-01-000001 runtime: cloud status: connected events: created: at: '2021-10-20T14:52:34.975326Z' status: running log_level: ERROR features: event_processing_available: true custom_api_available: true web_app_available: true anvil_app_available: true transformation_app_available: true eaas.EnvironmentStatsResponse: summary: '' description: '' value: id: ENV-4400-0874-01 type: development runtime: cloud instances: - id: INS-4400-0874-01-000001 stats: cpu_usage: name: CPU Usage description: CPU usage on all cores in millicores. unit: percentage average: 0.01 values: - timestamp: '2021-10-20T13:59:00+00:00' average: 0.1 - timestamp: '2021-10-20T13:59:00+00:00' average: 0.3 memory_usage: name: Memory Usage description: Total memory usage in byte. unit: percentage average: 0.39 values: - timestamp: '2021-10-20T13:59:00+00:00' average: 0 - timestamp: '2021-10-20T14:56:00+00:00' average: 6.1759488000000005 - timestamp: '2021-10-20T14:57:00+00:00' average: 6.1759488000000005 - timestamp: '2021-10-20T14:58:00+00:00' average: 6.1759488000000005 network_receive: name: Network Receive description: Network Bytes Received Per Second unit: bytes average: 3.96 values: - timestamp: '2021-10-20T14:55:00+00:00' average: 150.75 - timestamp: '2021-10-20T14:56:00+00:00' average: 60 - timestamp: '2021-10-20T14:57:00+00:00' average: 16 - timestamp: '2021-10-20T14:58:00+00:00' average: 11 network_transmit: name: Network Transmit description: Network Bytes Transmitted Per Second unit: bytes average: 1.86 values: - timestamp: '2021-10-20T14:55:00+00:00' average: 51 - timestamp: '2021-10-20T14:56:00+00:00' average: 26.75 - timestamp: '2021-10-20T14:57:00+00:00' average: 19 - timestamp: '2021-10-20T14:58:00+00:00' average: 15 eaas.EnvironmentTaskStatsResponse: summary: Environment task stats entries. description: Example of task stats entries for an environment. value: processing_count: name: Processing task count unit: count values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 scheduled_count: name: Scheduled task count unit: count values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 rescheduled_count: name: Rescheduled task count unit: count values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 succeeded_count: name: Succeeded task count unit: count values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 failed_count: name: Failed task count unit: count values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 total_count: name: Total task count unit: count values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 runtime_min: name: Task runtime min time unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 runtime_max: name: Task runtime max time unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 runtime_avg: name: Task runtime avg time unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 processing_min: name: Task processing min time unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 processing_max: name: Task processing max time unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 processing_avg: name: Task processing avg time unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 wait_time_min: name: Task wait time min unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 wait_time_max: name: Task wait time max unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 wait_time_avg: name: Task wait time avg unit: second values: - timestamp: '2022-11-09T08:51:00+00:00' value: 0 - timestamp: '2022-11-09T08:52:00+00:00' value: 0 - timestamp: '2022-11-09T08:53:00+00:00' value: 0 - timestamp: '2022-11-09T08:54:00+00:00' value: 0 - timestamp: '2022-11-09T08:55:00+00:00' value: 0 - timestamp: '2022-11-09T08:56:00+00:00' value: 0 - timestamp: '2022-11-09T08:57:00+00:00' value: 0 - timestamp: '2022-11-09T08:58:00+00:00' value: 0 - timestamp: '2022-11-09T08:59:00+00:00' value: 0 - timestamp: '2022-11-09T09:00:00+00:00' value: 0 - timestamp: '2022-11-09T09:01:00+00:00' value: 0 - timestamp: '2022-11-09T09:02:00+00:00' value: 0 - timestamp: '2022-11-09T09:03:00+00:00' value: 0 - timestamp: '2022-11-09T09:04:00+00:00' value: 0 - timestamp: '2022-11-09T09:05:00+00:00' value: 0 - timestamp: '2022-11-09T09:06:00+00:00' value: 0 - timestamp: '2022-11-09T09:07:00+00:00' value: 0 - timestamp: '2022-11-09T09:08:00+00:00' value: 0 - timestamp: '2022-11-09T09:09:00+00:00' value: 0 - timestamp: '2022-11-09T09:10:00+00:00' value: 0 - timestamp: '2022-11-09T09:11:00+00:00' value: 0 - timestamp: '2022-11-09T09:12:00+00:00' value: 0 - timestamp: '2022-11-09T09:13:00+00:00' value: 0 - timestamp: '2022-11-09T09:14:00+00:00' value: 0 - timestamp: '2022-11-09T09:15:00+00:00' value: 0 - timestamp: '2022-11-09T09:16:00+00:00' value: 0 - timestamp: '2022-11-09T09:17:00+00:00' value: 0 - timestamp: '2022-11-09T09:18:00+00:00' value: 0 - timestamp: '2022-11-09T09:19:00+00:00' value: 0 - timestamp: '2022-11-09T09:20:00+00:00' value: 0 - timestamp: '2022-11-09T09:21:00+00:00' value: 0 - timestamp: '2022-11-09T09:22:00+00:00' value: 0 - timestamp: '2022-11-09T09:23:00+00:00' value: 0 - timestamp: '2022-11-09T09:24:00+00:00' value: 0 - timestamp: '2022-11-09T09:25:00+00:00' value: 0 - timestamp: '2022-11-09T09:26:00+00:00' value: 0 - timestamp: '2022-11-09T09:27:00+00:00' value: 0 - timestamp: '2022-11-09T09:28:00+00:00' value: 0 - timestamp: '2022-11-09T09:29:00+00:00' value: 0 - timestamp: '2022-11-09T09:30:00+00:00' value: 0 - timestamp: '2022-11-09T09:31:00+00:00' value: 0 - timestamp: '2022-11-09T09:32:00+00:00' value: 0 - timestamp: '2022-11-09T09:33:00+00:00' value: 0 - timestamp: '2022-11-09T09:34:00+00:00' value: 0 - timestamp: '2022-11-09T09:35:00+00:00' value: 0 - timestamp: '2022-11-09T09:36:00+00:00' value: 0 - timestamp: '2022-11-09T09:37:00+00:00' value: 0 - timestamp: '2022-11-09T09:38:00+00:00' value: 0 - timestamp: '2022-11-09T09:39:00+00:00' value: 0 - timestamp: '2022-11-09T09:40:00+00:00' value: 0 - timestamp: '2022-11-09T09:41:00+00:00' value: 0 - timestamp: '2022-11-09T09:42:00+00:00' value: 0 - timestamp: '2022-11-09T09:43:00+00:00' value: 0 - timestamp: '2022-11-09T09:44:00+00:00' value: 0 - timestamp: '2022-11-09T09:45:00+00:00' value: 0 - timestamp: '2022-11-09T09:46:00+00:00' value: 0 - timestamp: '2022-11-09T09:47:00+00:00' value: 0 - timestamp: '2022-11-09T09:48:00+00:00' value: 0 - timestamp: '2022-11-09T09:49:00+00:00' value: 0 - timestamp: '2022-11-09T09:50:00+00:00' value: 0 avg: 0.0 eaas.GetGitTagsRequest-withAuth: summary: With auth description: '' value: git: url: https://github.com/cloudblue/private-repository.git auth: username: myGHUser password: myGHPassword eaas.GetGitTagsRequest-withoutAuth: summary: Without auth description: '' value: git: url: https://github.com/cloudblue/connect-cli.git eaas.GetGitTagsResponse: summary: response description: '' value: git: url: https://github.com/cloudblue/connect-cli.git tags: - '26.0' - '24.1' - '24.0' - '23.4' - '23.3' - '23.2' - '23.1' - '23.0' - '22.0' eaas.InstallationResponse: summary: Update settings description: '' value: id: EIN-2879-0245-8671 environment: id: ENV-7429-3197-01 type: development extension: id: SRVC-7429-3197 name: Telegram extension owner: id: VA-123-000 name: Vendor account 123 role: vendor extension_id: EXT-857-273 ui_modules: {} hostname: srvc-7429-3197-dev domain: ext.cnct.info git: {} runtime: local owner: id: VA-123-000 name: Vendor account 123 role: vendor settings: setting_one: https://cloudblue.com setting_two: - 1 - 2 - 3 setting_three: name: somename description: some description events: installed: at: '2022-11-11T08:17:47+00:00' by: id: SU-123-200-000 name: Account Token for 123 updated: at: '2022-11-11T08:17:47+00:00' status: installed eaas.ScheduleResponse: summary: Schedule object. description: The example is a full representation of the **Schedule** object. value: id: EFS-0000-0001 method: approve_regular_request_purchase parameter: amount: 33 id: 2 name: PR Approval description: Scheduled approval for regular purchase requests. trigger: type: onetime date: '2021-08-14T10:21:22+00:00' environment: id: ENV-2345-0000-01 type: development status: enabled events: created: at: '2021-08-14T10:21:22+00:00' by: id: UR-232-575-411 name: Test user updated: at: '2021-09-01T10:21:22+00:00' by: id: UR-232-575-411 name: Test user last_triggered: at: '2021-09-01T10:21:22+00:00' eaas.ScheduleResponse-list: summary: Schedule object. description: The example is a full representation of the **Schedule** object. value: - id: EFS-0000-0001 method: approve_regular_request_purchase parameter: amount: 33 id: 2 name: PR Approval description: Scheduled approval for regular purchase requests. trigger: type: onetime date: '2021-08-14T10:21:22+00:00' environment: id: ENV-2345-0000-01 type: development status: enabled events: created: at: '2021-08-14T10:21:22+00:00' by: id: UR-232-575-411 name: Test user updated: at: '2021-09-01T10:21:22+00:00' by: id: UR-232-575-411 name: Test user last_triggered: at: '2021-09-01T10:21:22+00:00' eaas.ServiceResponse: summary: Extension object. description: The example is a full representation of a **Extension** object. value: id: SRVC-4400-0874 type: products name: FallBall for business extension description: FallBall for business subscriptions fulfillment management. products: - id: PRD-440-256-612 name: FallBall icon: /media/VA-037-000/PRD-440-256-612/media/PRD-440-256-612-logo.png owner: id: VA-037-000 name: ACME Inc. events: created: at: '2021-10-20T10:35:37.405466Z' by: id: UR-037-000-000 name: Jon Doe updated: at: '2021-10-20T10:35:49.829793Z' by: id: UR-037-000-000 name: Jon Doe environments: development: id: ENV-4400-0874-01 type: development runtime: local external_id: 61649846-b931-4572-8304-43a301f82738 status: uninitialized capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: false category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: false category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false configuration_changed: false test: id: ENV-4400-0874-02 type: test runtime: local external_id: 5cf5cf27-fefa-4fcd-bedc-ed4351fb02d3 status: uninitialized capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: false category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: false category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false configuration_changed: false production: id: ENV-4400-0874-03 type: production runtime: local external_id: e8303354-72e7-4b55-80e6-f5dd9ae90eb0 status: uninitialized capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: false category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: false category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false configuration_changed: false eaas.ServiceResponse-list: summary: Extension object. description: The example is a full representation of a **Extension** object. value: - id: SRVC-4400-0874 type: products name: FallBall for business extension description: FallBall for business subscriptions fulfillment management. products: - id: PRD-440-256-612 name: FallBall icon: /media/VA-037-000/PRD-440-256-612/media/PRD-440-256-612-logo.png owner: id: VA-037-000 name: ACME Inc. events: created: at: '2021-10-20T10:35:37.405466Z' by: id: UR-037-000-000 name: Jon Doe updated: at: '2021-10-20T10:35:49.829793Z' by: id: UR-037-000-000 name: Jon Doe environments: development: id: ENV-4400-0874-01 type: development runtime: local external_id: 61649846-b931-4572-8304-43a301f82738 status: uninitialized capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: false category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: false category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false configuration_changed: false test: id: ENV-4400-0874-02 type: test runtime: local external_id: 5cf5cf27-fefa-4fcd-bedc-ed4351fb02d3 status: uninitialized capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: false category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: false category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false configuration_changed: false production: id: ENV-4400-0874-03 type: production runtime: local external_id: e8303354-72e7-4b55-80e6-f5dd9ae90eb0 status: uninitialized capabilities: - id: asset_purchase_request_processing label: Purchase Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_processing label: Change Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_suspend_request_processing label: Suspend Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_resume_request_processing label: Resume Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_cancel_request_processing label: Cancellation Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_adjustment_request_processing label: Adjustment Request group: id: subscription label: Subscription category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_processing label: Setup Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_processing label: Change Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_adjustment_request_processing label: Adjustment Request group: id: tier_config label: Tier Config category: processing enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: asset_purchase_request_validation label: Purchase Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: asset_change_request_validation label: Change Request group: id: subscription label: Subscription category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false scheduled: false revoking: false revoked: false - id: tier_config_setup_request_validation label: Setup Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: tier_config_change_request_validation label: Change Request group: id: tier_config label: Tier Config category: validation enabled: false statuses: draft: false tiers_setup: false pending: false inquiring: false approved: false failed: false - id: product_action_execution label: Action Execution group: id: product label: Product enabled: false category: '' - id: product_custom_event_processing label: Custom Event Processing group: id: product label: Product enabled: false category: '' - id: listing_new_request_processing label: New Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false - id: listing_remove_request_processing label: Remove Request group: id: listing label: Listing enabled: false category: '' statuses: draft: false reviewing: false deploying: false canceled: false completed: false configuration_changed: false eaas.TaskResponse: summary: Task object. description: '' value: id: TQ-9481-7650-8096-0593 object: id: PR-9654-2758-5816-001 type: asset_purchase_request_processing category: background assignee: INS-4400-0874-01-000001 status: succeeded environment: id: ENV-4400-0874-01 type: development owner: id: VA-037-000 name: ACME Inc events: created: at: '2021-10-20T16:35:08.111178Z' updated: at: '2021-10-20T16:35:14.507087Z' assigned: at: '2021-10-20T16:35:14.367281Z' completed: at: '2021-10-20T16:35:14.506974Z' eaas.TaskResponse-list: summary: Task object. description: '' value: - id: TQ-9481-7650-8096-0593 object: id: PR-9654-2758-5816-001 type: asset_purchase_request_processing category: background assignee: INS-4400-0874-01-000001 status: succeeded environment: id: ENV-4400-0874-01 type: development owner: id: VA-037-000 name: ACME Inc events: created: at: '2021-10-20T16:35:08.111178Z' updated: at: '2021-10-20T16:35:14.507087Z' assigned: at: '2021-10-20T16:35:14.367281Z' completed: at: '2021-10-20T16:35:14.506974Z' eaas.UninstallRequest: summary: Uninstall description: '' value: comment: Uninstall reason! eaas.UpdateEnvironmentRequest-cloud: summary: Update environment (cloud mode). description: 'Updates a cloud environment or change to cloud mode. If the environment is a newly created environment (local), the `git` node is required. Git credentials (`auth` node) are optional. `jwt_secret` is optional.' value: runtime: cloud jwt_secret: a_jwt_secret_for_custom_events_authentication git: url: https://github.com/globex/FallBall-service.git tag: 2.0.0 auth: username: myuser password: mypass eaas.UpdateEnvironmentRequest-local: summary: Update an environment (local mode). description: 'Updates a local environment or change to local mode. `jwt_secret` is optional.' value: runtime: local jwt_secret: a_jwt_secret_for_custom_events_authentication eaas.UpdateInstallationRequest: summary: Update settings description: '' value: environment: id: ENV-123-456 settings: setting_one: https://cloudblue.com setting_two: - 1 - 2 - 3 setting_three: name: somename description: some description eaas.UpdateInstallationSettingsRequest: summary: Update settings description: '' value: settings: setting_one: https://cloudblue.com setting_two: - 1 - 2 - 3 setting_three: name: somename description: some description eaas.UpdateScheduleRequest: summary: Update a schedule. description: Any of the following fields can be updated. Please look at the **Create schedule** operation to see examples of the different trigger types. value: name: PR Approve description: Scheduled approval for regular purchase requests. parameter: input: data some: new-value trigger: type: onetime date: '2021-12-15T00:00:00+00:00' eaas.UpdateServiceRequest: summary: Update a extension. description: Any of the following fields can be updated. value: name: FallBall for business PRO plan extension description: This extension manages the fulfillment of FallBall for business PRO subscriptions. helpdesk.Attachment: summary: Attachment object description: The example is a full representation of a **Attachment** object value: id: CAAT-174-196-947 account: id: VA-521-964 name: ACME Inc. icon: '' attachment: /public/v1/helpdesk/cases/CA-594-965-699/attachments/CAAT-174-196-947?format=attachment size: 549735 preview: /public/v1/helpdesk/cases/CA-594-965-699/attachments/CAAT-174-196-947?format=preview name: Screenshot.png events: created: at: '2021-11-16T09:13:03+00:00' by: id: SU-910-817-511 name: John Doe type: image/png helpdesk.Attachment-list: summary: Attachment object description: The example is a full representation of a **Attachment** object value: - id: CAAT-174-196-947 account: id: VA-521-964 name: ACME Inc. icon: '' attachment: /public/v1/helpdesk/cases/CA-594-965-699/attachments/CAAT-174-196-947?format=attachment size: 549735 preview: /public/v1/helpdesk/cases/CA-594-965-699/attachments/CAAT-174-196-947?format=preview name: Screenshot.png events: created: at: '2021-11-16T09:13:03+00:00' by: id: SU-910-817-511 name: John Doe type: image/png helpdesk.Case: summary: Case Object with Product details description: The example is a full representation of a **Case** object value: id: CA-485-157-569 product: id: PRD-146-078-741 name: FallBall icon: /media/VA-521-964/PRD-146-078-741/media/PRD-146-078-741-logo.png subject: My issue description: I have some very interesting case priority: 1 state: pending type: technical issuer: account: id: VA-521-964 name: ACME Inc. icon: '' agent: id: UR-630-250-903 name: Bill Doe recipients: - id: UR-630-250-903 name: John Fet receiver: account: id: PA-218-422 name: CORP Inc. icon: /media/PA-218-422/media/icon_A6agTP9.png agent: id: UR-630-250-903 name: John Doe recipients: - id: UR-630-250-903 name: John Smith events: created: at: '2021-11-15T12:07:39+00:00' by: id: UR-630-250-903 name: John Doe updated: at: '2021-11-15T15:20:09+00:00' by: id: UR-630-250-903 name: Chris Bart pending: at: '2021-11-15T12:07:39+00:00' by: id: UR-630-250-903 name: John Doe helpdesk.Case-list: summary: Case Object with Product details description: The example is a full representation of a **Case** object value: - id: CA-485-157-569 product: id: PRD-146-078-741 name: FallBall icon: /media/VA-521-964/PRD-146-078-741/media/PRD-146-078-741-logo.png subject: My issue description: I have some very interesting case priority: 1 state: pending type: technical issuer: account: id: VA-521-964 name: ACME Inc. icon: '' agent: id: UR-630-250-903 name: Bill Doe recipients: - id: UR-630-250-903 name: John Fet receiver: account: id: PA-218-422 name: CORP Inc. icon: /media/PA-218-422/media/icon_A6agTP9.png agent: id: UR-630-250-903 name: John Doe recipients: - id: UR-630-250-903 name: John Smith events: created: at: '2021-11-15T12:07:39+00:00' by: id: UR-630-250-903 name: John Doe updated: at: '2021-11-15T15:20:09+00:00' by: id: UR-630-250-903 name: Chris Bart pending: at: '2021-11-15T12:07:39+00:00' by: id: UR-630-250-903 name: John Doe helpdesk.CreateCase-dist_to_vendor_w_prod: summary: New Case (Distributor->Vendor) with Product Technical description: When you create a new Case as a Distributor, you should use your distributor API token. Please check [Connect documentation](https://connect.cloudblue.com/community/modules/extensions/api-tokens/) for more details. value: subject: Asset AS-123-000-987 for John Doe long running description: Hello, provisioning of the asset takes a lot of time. Please advise. product: id: PRD-146-078-741 priority: 3 state: pending type: technical issuer: recipients: - id: UR-630-250-903 receiver: account: id: VA-521-964 helpdesk.CreateCase-vendor_to_dist_no_prod: summary: New Case (Vendor->Distributor) without Product value: subject: I have a question / problem description: Need help with regards to Contracts management. priority: 0 state: pending type: business issuer: recipients: - id: UR-630-250-903 receiver: account: id: PA-218-422 helpdesk.CreateCase-vendor_to_dist_no_prod_hub: summary: New Case (Vendor->Distributor) without Product Technical value: subject: I have a question / problem description: Marketplace Hub is not configured properly. priority: 3 state: pending type: technical issuer: recipients: - id: UR-630-250-903 receiver: account: id: PA-218-422 helpdesk.CreateCase-vendor_to_dist_w_prod: summary: New Case (Vendor->Distributor) with Product Technical value: subject: Asset AS-123-000-987 for John Doe long running description: Hello, provisioning of the asset will take a lot of time due to XYZ. product: id: PRD-146-078-741 priority: 3 state: pending type: technical issuer: recipients: - id: UR-630-250-903 receiver: account: id: PA-218-422 helpdesk.Settings: summary: Settings Object description: The example is a full representation of a **Settings** object value: ttl: 30 mode: builtin instructions: '# We''re here to help Please follow these instructions and we''ll guide you to the best solution. ## Support by phone You can talk to a support representative by calling the phone number for your country or region. [Find the number for your location](https://example.com) ## Support anywhere Use our Support Portal to find answers about your problems. [Online support portal](https://example.com)' events: created: at: '2021-11-10T10:35:54+00:00' updated: at: '2021-11-16T12:11:30+00:00' by: id: UR-630-250-903 name: John Doe helpdesk.UpdateCase-change_case_product: summary: Change the product of the case value: product: id: PRD-146-078-741 helpdesk.UpdateCase-update_priority: summary: Change priority of the case value: priority: 3 helpdesk.UpdateCase-update_subj_and_desc: summary: Change subject and description of the case value: subject: New Subject description: New description helpdesk.UpdateCase-update_type: summary: Change type of the case value: type: business helpdesk.UpdateSettings-update_mode_and_instructions_builtin: summary: Change mode and instructions to builtin value: mode: builtin instructions: null helpdesk.UpdateSettings-update_mode_and_instructions_federated: summary: Change mode and instructions to federated value: mode: federated instructions: '# We''re here to help Please follow these instructions and we''ll guide you to the best solution. ## Support by phone You can talk to a support representative by calling the phone number for your country or region. [Find the number for your location](https://example.com) ## Support anywhere Use our Support Portal to find answers about your problems. [Online support portal](https://example.com)' helpdesk.UpdateSettings-update_ttl: summary: Change the Autoclose timeout value: ttl: 45 localization.CreateLocalizationContext: summary: Create Localization Context response description: This is a full representation of a **Localization Context** object value: instance_id: PRD-123-123-123 name: Product 1 icon: /media/english-flag.png type: product translations: - locale: id: EN-GB primary: true auto_translation: enabled: false description: My Awesome Translation localization.CreateTranslation-new_bulk_translation: summary: Bulk Create Translation request description: This is a representation of a **Translation** objects for bulk create action value: - context: id: LCX-1234-1234-123 locale: id: ES-MX description: Awesome Mexican Spanish locale auto: enabled: true - context: id: LCX-1234-1234-123 locale: id: ES description: Awesome Spanish locale auto: enabled: false localization.CreateTranslation-new_translation: summary: Create Translation request description: This is a representation of a **Translation** object for create action value: context: id: LCX-1234-1234-123 locale: id: EN-GB description: Awesome British English locale auto: enabled: true localization.GetLocalizationContext: summary: Retrieve Localization Context Object description: This is a full representation **Localization Context** object value: id: LCX-1233-3211-1233-1233 instance_id: PRD-123-123-123 name: Product 1 icon: /media/english-flag.png type: product translations: - id: TRN-1234-1234-1234 locale: id: EN-GB name: English (Great Britain) primary: true status: active owner: id: VA-051-000 name: ACME Inc. localization.Locale-GET-Extended-list: summary: Locale Object with Marketplaces description: This is a full representation of a **Locale** object, with select(marketplaces) on querystring value: - id: EN-GB name: British English local_name: British English auto_translation: true marketplaces: - id: MP-00001 name: France icon: /media/MP-00001/icon.png stats: translations: 10 localization.Locale-GET-list: summary: Locale Object without Marketplaces description: This is a partial representation of a **Locale** object, without select(marketplaces) on querystring value: - id: EN-GB name: British English local_name: British English auto_translation: true stats: translations: 10 localization.LocaleRetrieveResponse: summary: Retrieve **Locale Object** response description: This is a full representation of a **Locale** object value: id: EN-GB name: British English local_name: British English auto_translation: true marketplaces: - id: MP-00001 name: France icon: /media/MP-00001/icon.png stats: translations: 10 localization.LocalizationContext-GET-extended-list: summary: Localization Context objects with Translations details description: The full **Localization Context** object representation, with select(translations) on querystring value: - id: LCX-1233-3211-1233-1233 instance_id: PRD-123-123-123 name: Product 1 icon: /media/english-flag.png type: product translations: - id: TRN-1234-1234-1234 locale: id: EN-GB name: English (Great Britain) primary: true status: active owner: id: VA-051-000 name: ACME Inc. localization.LocalizationContext-GET-list: summary: Localization Context objects without Translations details description: The base **Localization Context** object representation, without select(translations) on querystring value: - id: LCX-1233-3211-1233-1233 instance_id: PRD-123-123-123 name: Product 1 icon: /media/english-flag.png type: product localization.LocalizationContextCreateResp: summary: Create Localization Context Object request description: The base **Localization Context** object representation required for create action value: id: LCX-1233-3211-1233-1233 instance_id: PRD-123-123-123 name: Product 1 icon: /media/english-flag.png type: product localization.Translation: summary: Translation object description: This is a full representation of a **Translation** object value: id: TRN-6783-3216-8782 context: id: LCX-000-000-0097 instance_id: PRD-000-000-0097 name: Product ready icon: /media/icon.jpg type: product owner: id: VA-000-248 name: Mckenzie Chaney icon: /media/icon.jpg locale: id: EN name: English stats: total: 20 translated: 16 description: Awesome english locale auto: enabled: true status: failed error_message: Cannot connect to server status: inactive events: updated: at: '2022-01-18T12:32:14+00:00' by: id: UR-000-323 name: John Doe icon: /media/icon.png created: at: '2022-01-18T12:32:14+00:00' by: id: UR-000-323 name: John Doe icon: /media/icon.png primary: false error_message: 'Failed to create Primary Locale. Reason: some error. Retry.' localization.Translation-list: summary: Translation object description: This is a full representation of a **Translation** object value: - id: TRN-6783-3216-8782 context: id: LCX-000-000-0097 instance_id: PRD-000-000-0097 name: Product ready icon: /media/icon.jpg type: product owner: id: VA-000-248 name: Mckenzie Chaney icon: /media/icon.jpg locale: id: EN name: English stats: total: 20 translated: 16 description: Awesome english locale auto: enabled: true status: failed error_message: Cannot connect to server status: inactive events: updated: at: '2022-01-18T12:32:14+00:00' by: id: UR-000-323 name: John Doe icon: /media/icon.png created: at: '2022-01-18T12:32:14+00:00' by: id: UR-000-323 name: John Doe icon: /media/icon.png primary: false error_message: 'Failed to create Primary Locale. Reason: some error. Retry.' localization.TranslationAttribute: summary: Translation Attribute object description: This is a full representation of a **Translation Attribute** object value: key: product.PRD-123-133-123.name value: Oficina 365 comment: Fixed value auto_translated: false events: updated: at: '2022-02-01T09:53:45+00:00' by: id: UR-000-228 name: John Dow icon: /media/icon.png created: at: '2022-02-01T09:53:45+00:00' by: id: UR-000-228 name: John Dow icon: /media/icon.png localization.TranslationAttribute-list: summary: Translation Attribute object description: This is a full representation of a **Translation Attribute** object value: - key: product.PRD-123-133-123.name value: Oficina 365 comment: Fixed value auto_translated: false events: updated: at: '2022-02-01T09:53:45+00:00' by: id: UR-000-228 name: John Dow icon: /media/icon.png created: at: '2022-02-01T09:53:45+00:00' by: id: UR-000-228 name: John Dow icon: /media/icon.png localization.TranslationTask: summary: Translation Task object description: This is a full representation of a **Translation Task** object value: id: TRNT-1233-3211-1233 type: attributes_import arguments: format: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet status: error error_message: 'Error during import: XYZ' file: https://domain.com/file.xlsx events: created: at: 2020-01-01T00:00 by: id: UR-123-123 name: John Doe finished: at: 2020-01-01T00:00 localization.TranslationTask-list: summary: Translation Task object description: This is a full representation of a **Translation Task** object value: - id: TRNT-1233-3211-1233 type: attributes_import arguments: format: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet status: error error_message: 'Error during import: XYZ' file: https://domain.com/file.xlsx events: created: at: 2020-01-01T00:00 by: id: UR-123-123 name: John Doe finished: at: 2020-01-01T00:00 localization.Update: summary: Update Translation Attribute request description: This is a representation of a **Translation Attribute** object required for update action value: value: Oficina MS 365 comment: Fixed the name localization.UpdateBulk: summary: Bulk Update Translation Attributes request description: This is a representation of a **TranslationAttribute** objects required for bulk update action value: - key: product.PRD-123-133-123.name value: The new proper name - key: product.PRD-123-133-123.description value: This is so cool Product comment: New description as agreed with marketing localization.UpdateTranslation: summary: Update Translation request description: This is a representation of a **Translation** object for update action value: description: Awesome English locale auto: enabled: true localization.UpdateTranslationsBulk: summary: Bulk Update Translation objects description: This is a representation of a **Translation** objects for bulk update action value: - id: TRN-6783-3216-8782 description: Awesome English locale auto: enabled: true - id: TRN-6783-0001-8782 description: Awesome Spanish locale slm.Sla: summary: SLA Object description: The example is a full representation of a **SLA** object value: id: SLA-241-738-946 owner: id: PA-218-422 name: CORP Inc. icon: /media/PA-218-422/media/icon_A6agTP9.png active: false entity_type: subscription_request slos: - id: SLO-241-738-946-001 target_status: draft terminate: false zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 2 zone: 2 - id: SLO-241-738-946-002 target_status: inquiring terminate: false zones: - days: 5 zone: 0 - days: 5 zone: 1 - days: 5 zone: 2 - id: SLO-241-738-946-003 target_status: pending terminate: true final_action: reject zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 2 zone: 2 - id: SLO-241-738-946-004 target_status: revoking terminate: false zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 0 zone: 2 events: created: at: '2022-03-23T17:49:39+00:00' updated: at: '2022-03-23T17:49:39+00:00' slm.Sla-list: summary: SLA Object description: The example is a full representation of a **SLA** object value: - id: SLA-241-738-946 owner: id: PA-218-422 name: CORP Inc. icon: /media/PA-218-422/media/icon_A6agTP9.png active: false entity_type: subscription_request slos: - id: SLO-241-738-946-001 target_status: draft terminate: false zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 2 zone: 2 - id: SLO-241-738-946-002 target_status: inquiring terminate: false zones: - days: 5 zone: 0 - days: 5 zone: 1 - days: 5 zone: 2 - id: SLO-241-738-946-003 target_status: pending terminate: true final_action: reject zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 2 zone: 2 - id: SLO-241-738-946-004 target_status: revoking terminate: false zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 0 zone: 2 events: created: at: '2022-03-23T17:49:39+00:00' updated: at: '2022-03-23T17:49:39+00:00' slm.Sli: summary: SLI Object description: The example is a full representation of a **SLI** object value: id: SLI-345-898-896 slo: id: SLO-484-011-359-003 sla: id: SLA-484-011-359 entity_type: subscription_request target_status: pending terminate: false final_action: reject zones: - days: 1 zone: 0 - days: 3 zone: 1 - days: 4 zone: 2 entity_id: PR-7382-7379-5292-001 zone: 0 days: 1 start_date: '2022-04-15T11:25:47+00:00' events: created: at: '2022-04-15T11:25:47+00:00' updated: at: '2022-04-15T11:25:47+00:00' slm.Sli-list: summary: SLI Object description: The example is a full representation of a **SLI** object value: - id: SLI-345-898-896 slo: id: SLO-484-011-359-003 sla: id: SLA-484-011-359 entity_type: subscription_request target_status: pending terminate: false final_action: reject zones: - days: 1 zone: 0 - days: 3 zone: 1 - days: 4 zone: 2 entity_id: PR-7382-7379-5292-001 zone: 0 days: 1 start_date: '2022-04-15T11:25:47+00:00' events: created: at: '2022-04-15T11:25:47+00:00' updated: at: '2022-04-15T11:25:47+00:00' slm.UpdateSla-change_sla_active: summary: Change SLA `active` status value: active: true slm.UpdateSla-change_sla_slo: summary: Change SLA's SLO settings value: slos: - id: SLO-241-738-946-001 target_status: draft terminate: false zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 2 zone: 2 - id: SLO-241-738-946-002 target_status: inquiring terminate: false zones: - days: 5 zone: 0 - days: 5 zone: 1 - days: 5 zone: 2 - id: SLO-241-738-946-003 target_status: pending terminate: true final_action: reject zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 2 zone: 2 - id: SLO-241-738-946-004 target_status: revoking terminate: false zones: - days: 1 zone: 0 - days: 1 zone: 1 - days: 0 zone: 2 headers: Connect-Localization: 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: type: string Content-Range: schema: type: string description: RQL RFC2616 limit offset pagination. securitySchemes: Apikey0: in: header name: Authorization type: apiKey tags: - name: ACL description: '' - name: Accounts description: '' - name: Agreements description: Control the lifecycle of agreements (contract templates) with the Agreements Management endpoints. - name: Assets description: Review, test and manage assets of products with the Assets Management endpoints. - name: Auth description: '' - name: Brands description: '' - name: Catalog description: '' - name: Contracts description: Manage contracts with your partners with the Contracts Management endpoints. - name: Conversations description: "\nConversations module allows to manage your conversations in different\ \ objects. This \ncan be a conversation in Fulfillment requests, Helpdesk, etc.\n" - name: Custom Attributes description: Create and manage Custom Attributes - name: Customers description: View and manage your customers (tier accounts) with the Customers Management endpoints. - name: DevOps description: ' ### Introduction The **DevOps** module allows managing your *Extension as a Service* environments within the CloudBlue Connect system. For more information about *Extension as a Service* and the **DevOps** module please visit our [Community Portal](https://connect.cloudblue.com/community/modules/devops/). ### Extension A **Extension** object represents an **Extension** that can manage events generated by Connect. For each Extension, three environments will be created: `development`, `test` and `production`. These environments can be deployed on the Connect managed infrastructure (cloud mode) or on a custom infrastructure (local mode). There are four types: * `products`: extension used by Vendor to manage fulfillment events related to N products. * `hub`: extension used by Distributor to manage hub related events. * `multiaccount`: extension used by both Vendor and Distributor that allow you not only to manage events but also to create a custom API to serve any kind of requests. It might be publicly available for other users to use. * `transformations`: extension used by both Vendor and Distributor that allow you not only to manage events but also to manage transformation functions that could be used by others. It might be publicly available for other users to use. ### Environment An **Environment** represent an instance of a specific **Extension** version, that can process events generated for the specific environment. The DevOps module deploys the Extension code taking it directly from the Extension Git repository. The Extension lifecycle is managed using Git tags. The Extension configuration is managed per environment using **Variables**. ### Variables **Variables** are key/value pairs that will be sent to the Extension code in the form of a Python dictionary. Each environment will have its own set of variables. A Variable has a `secure` flag to hide its value on both the Connect API and UI. ### Tasks Tasks are unit of work that an Extension has to process. The DevOps module handles a queue of Tasks for each task category. There are three task categories: * `background`: tasks generated by events that can be processed in background like for example fulfillment events * `interactive`: tasks whose result must be returned immediately to the user, like for example shopping cart validation * `scheduled`: like background tasks but generated recurrently according to a schedule ### Schedules The DevOps module allows to execute tasks periodically. An Extension can implements any number of schedulable functions that can be scheduled on a per-environment basis. A **Schedule** object represent a periodic execution of a schedulable function with an arbitrary input parameter in the form of a JSON object. Three types of triggers can be configured for a Schedule: * `onetime`: the schedulable function will be executed just once on a specific datetime * `recurring`: the schedulable function will be executed every `amount` of `unit` where unit can be days, weeks or months * `advanced`: the schedulable function will be executed based on a [standard Unix Cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) ### Catalog requests The multiaccount or transformations Extensions might be publicly available. For making this possible it is used the catalogs requests which allow you to request to make an Extension public or make it private again. A **CatalogRequest** object represent a publish/unpublish request done for an specific Extension. ### Installations The Connect users now could install multiaccount or transformations Extensions that are public or a private one using an invitation code. A **Installation** object represent a relation between the user and the extension, that means that the user will benefit from the installed Extension functionalities. ### Invitations The multiaccount or transformations Extension owners now could create invitations that other Connect users could use to install their Extension. An Invitation could only be used once by a user that has no installation over the Extension. A **Invitation** object represent for a given extension a code that could be used to install the Extension. ### Transformations The DevOps module allows to manage transformation functions. An Extension can implements any number of transformation functions that can be used by others to process files. A **TransformationFunction** object represent a transformation function defined in an extension. ' - name: Domains description: '' - name: Embedded Listings description: Create a Lead or get the Form of a Listing for embedded applications - name: Extensions description: Create and manage API tokens, access information and other integrations with the Extensions Management endpoints. - name: Files description: '' - name: General Collections description: Common collections. - name: Guidelines description: View and manage the guidelines information in the Guidelines Management endpoints. - name: Helpdesk description: "\n\nThe [Helpdesk](https://connect.cloudblue.com/community/modules/helpdesk/)\ \ \nmodule enables Partners (Vendors, Distributors, or Resellers) that have at\ \ least one \nactive Contract on the CloudBlue Connect platform with each other\ \ to address troubleshooting and \nsupport management by creating Cases.\n\nCreate\ \ cases within the Helpdesk module to submit your issues or requests to certain\ \ Partners. \nExample use cases include, but not limited to:\n * Selecting a Vendor\ \ partner to submit an issue. For instance, to investigate why an order was not\ \ provisioned on time.\n * Choosing a Distributor partner to create a request.\ \ For example, to ask for more details about a specific listing requirement.\n\ \ * Selecting CloudBlue support to report an error or a problem with the CloudBlue\ \ Connect platform.\n\nIn addition to an issue type, problem description, and\ \ priority data, each Case provide **Attachments** and **Comments** fields. \n\ Attachments allow Partners to upload files, such as logs or screenshots to support\ \ the case.\n\nComments contain submitted messages that enable communication between\ \ Partners. Furthermore, Comments can \nbe used to submit Private messages. Thus,\ \ a private message is available only for users of an account that \nsubmitted\ \ this message.\n\nWhen a Case is created, the system assigns the Pending state\ \ to it. If more information is required from your Partner, \nyou can transfer\ \ your Case to the Inquiring state. Once a Case is resolved, it is possible to\ \ mark outgoing or incoming \nCases as Resolved. Thereafter, you can close your\ \ outgoing Cases and provide a feedback.\n" - name: Hubs description: Register and manage instances of your Commerce Management systems with the Hubs Management endpoints. - name: Leads description: Create and manage Leads and Lead Forms - name: Listings description: Monitor and process the queue of listing requests from your partners with the Listings Management endpoints. - name: Localization description: "\n### Introduction\nThe **Localization** module allows managing your\ \ *Translations* and *Translation Attributes* \n within the CloudBlue Connect\ \ system.\nFor more information about *Localization* module please visit our\n\ [Community Portal](https://connect.cloudblue.com/community/modules/localization/).\n\ \n### Localization Context\nA **Localization Context** object represents a particular\ \ **scope** that holds translations.\nEach localization context is bound to an\ \ object in Connect, i.e. Product, and contains Translations\nfor selected Locales.\n\ \n### Translation\nA **Translation** represent a set of strings (Translation Attributes)\ \ which are available for \ntranslation for specific localization context, account\ \ and locale. Translations endpoint supports\nbulk operations, such as bulk create,\ \ bulk update and bulk destroy. \n\n### Translation Attribute\n**Translation Attributes**\ \ are objects which represent actual strings which can be translated\nwithin a\ \ particular Translation. Translation Attributes endpoint supports bulk operations,\ \ \nsuch as bulk update. \n" - name: Marketplaces description: Define and control assignment of Hubs and Accounts to the Marketplaces with the Marketplaces Management endpoints. - name: Metrics description: Retrieve some metrics data in the Metrics Management endpoints. - name: Notification Rules description: Manage rules for selecting recipients and email templates based on conditions (for example, marketplace). - name: Notification settings description: Manage datetime locale email context settings per account. - name: Offers description: Create and manage Offers - name: Offers Attributes Forms description: List and retrieve the Offers Attributes Forms - name: Offers Blueprints description: Create and manage Offers Blueprint Plans - name: Offers Presets description: Create and manage Offers Presets - name: PIM description: Product Information Management - name: Partners description: '' - name: Portals description: '' - name: PresetVersions description: '' - name: Pricing description: "\n# Create and manage PriceLists of Products with the Pricing Management\ \ endpoints.\n\nUse cases:\n\n* create PriceList and it's PriceListVersion\n\n\ * download PriceListVersion XLSX representation for using in bulk update operations\n\ \n* work with draft statused PriceListVersion:\n\n * via REST API with each\ \ PricePoint\n\n * via uploading through XLSX file bulk PricePoint update\n\ \n* activate PriceListVersion or schedule activation in future\n\n* terminate\ \ PriceList\n\n* download XLSX PriceListVersion representation\n\n_Notes:_\n\n\ * PriceList becomes visible to Provider after PriceList to Listing binding (see\ \ listings API collection)\n\n* Provider can access for PriceList with statuses\ \ 'active', 'scheduled' or 'terminated'\n\n* Provider can access for PriceListVersion\ \ with statuses 'active', 'scheduled' or 'expired'\n " - name: Products description: Review, test and manage your products with the Products Management endpoints. - name: Reports description: Reports management module. - name: SLM description: "\n\nSLM (Service Level Management) module allows to manage your SLAs\ \ (Service Level Agreements) \nto maintain desired quality of processing of such\ \ entities as Subscription Requests and Tier Configuration Requests.\n\n\n" - name: Settings description: View and manage the tier configuration information in the Settings Management endpoints. - name: Statistics description: Create and manage statistics - name: Streams description: '' - name: Subscriptions description: Review, test and manage subscriptions of products with the Subscriptions Management endpoints. - name: Usage Reporting description: '' - name: User description: '' - name: streams description: "\n# Create and manage streams\n "