Search bundles

For a provider organization, all bundles that contain the offered products are returned. For a consumer organization, all bundles created by that organization are returned.

Query Parameters
filter string Filters the results based on properties and values. Multiple properties can be concatenated with OR. Allow filter by organizationId at the end with AND operator. Currently the following properties are supported: Deprecated status contractStatus organizationId Example (Bundles: requested): contractStatus:REQUESTED Example (Bundles: requested or in-progress and organizationId): contractStatus:REQUESTED OR contractStatus:IN_PROGRESS AND organizationId:7f4004bd-c7ca-42c7-a9f6-da4c75d45a2e Example (Bundles: requested or in-progress): contractStatus:REQUESTED OR contractStatus:IN_PROGRESS
q string Free text with which to search via the following properties: Bundle.name Bundle.description Bundle.providerOrganization.name Bundle.product.name The text matches with 'ignore case contains'
sort string Sort results by given property and ASC | DESC. Example (Last added): createdAt desc Example (Default): name asc

Header Parameters
organization-id uuid — REQUIRED ID of organization context this request belongs to.

Responses
200 List of bundles. Schema — OPTIONAL bundles object[] — OPTIONAL accesses object[] — OPTIONAL accessExchangeType string — OPTIONAL Possible values: [GENERATE_TOKEN, MANUAL_EXCHANGE] accessStatus object[] — OPTIONAL statusValue string — OPTIONAL Possible values: [ACTIVATION_REQUESTED, ACTIVE, DEACTIVATION_REQUESTED, INACTIVE] createdAt date-time — OPTIONAL createdBy uuid — OPTIONAL note string — OPTIONAL authenticator — OPTIONAL createdAt date-time — OPTIONAL createdBy uuid — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL productIds uuid[] — OPTIONAL approvals object[] — OPTIONAL approvalStatus string — OPTIONAL Possible values: [REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, TERMINATED] createdAt date-time — OPTIONAL createdBy uuid — OPTIONAL note string — OPTIONAL bundleProducts object[] — OPTIONAL bundleProductPlans object[] — OPTIONAL Use: subscriptions, which has additional fields. approvals object[] — OPTIONAL approvalStatus string — OPTIONAL Possible values: [REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, TERMINATED] createdAt date-time — OPTIONAL createdBy uuid — OPTIONAL note string — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL version int32 — OPTIONAL subscriptions object[] — OPTIONAL approvals object[] — OPTIONAL approvalStatus string — OPTIONAL Possible values: [REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, TERMINATED] createdAt date-time — OPTIONAL createdBy uuid — OPTIONAL note string — OPTIONAL id uuid — OPTIONAL planDescription string — OPTIONAL planId uuid — OPTIONAL planName string — OPTIONAL planType string — OPTIONAL Possible values: [STATIC, DYNAMIC] validUntil date-time — OPTIONAL colour string — OPTIONAL createdAt date-time — OPTIONAL description string — OPTIONAL detailedDescription string — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL publiclyAvailable boolean — OPTIONAL accessDefinitionId uuid — OPTIONAL bundleStatus string — OPTIONAL Possible values: [DRAFT, REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, TERMINATED] Use: contractStatus businessCases object[] — OPTIONAL businessCaseKey string — OPTIONAL Possible values: [USE_CASE, ADDED_VALUE, TRAFFIC] pendingText string — OPTIONAL text string — OPTIONAL contact object — OPTIONAL id uuid — OPTIONAL createdAt date-time — OPTIONAL createdById uuid — OPTIONAL defaultContact boolean — OPTIONAL email string — OPTIONAL name string — OPTIONAL phone string — OPTIONAL contractStatus string — OPTIONAL Possible values: [DRAFT, REQUESTED, IN_PROGRESS, APPROVED, REJECTED, IN_TERMINATION, TERMINATED] createdAt date-time — OPTIONAL createdById uuid — OPTIONAL description string — OPTIONAL iconPath string — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL organizationId uuid — OPTIONAL accessStatus object — OPTIONAL access boolean — OPTIONAL accessNote string — OPTIONAL providerId uuid — OPTIONAL providerOrganization object — OPTIONAL email string — OPTIONAL id uuid — OPTIONAL name string — OPTIONAL provider boolean — OPTIONAL active boolean — OPTIONAL
400 Bad Request (e.g. element not found or resource conflict). Schema — OPTIONAL message string — OPTIONAL timestamp date-time — OPTIONAL traceId string — OPTIONAL type string — OPTIONAL
403 Missing permission Schema — OPTIONAL message string — OPTIONAL timestamp date-time — OPTIONAL traceId string — OPTIONAL type string — OPTIONAL
500 Internal server error (Internal service communication or process error). Schema — OPTIONAL message string — OPTIONAL timestamp date-time — OPTIONAL traceId string — OPTIONAL type string — OPTIONAL