Use the Create consumer app operation to create a consumer application
in a specified catalog for a consumer organization in IBM®
API Connect.
Manage consumer-related operations in IBM
API Connect, including listing
organizations, applications, credentials, and subscriptions, and creating consumer applications and
subscriptions.
The consumer-related operations supports the following operations:
List consumer organizations
Lists consumer organizations (orgs) from a catalog in an
IBM
API Connect instance provider
organization. It takes the catalog name as input and returns all the consumer organizations from
that catalog.
Table 1. Parameters
| Field name |
Type |
Default value |
Description |
| Name |
String |
Sandbox |
ID or name of the catalog from which the consumer orgs are listed. |
| Description (optional) |
Integer |
100 |
This optional field provides a brief summary of the project’s purpose or content. |
| Tags (optional) |
Integer |
0 |
You can add keywords in this optional field that describe the project’s focus or
category. |
You can use the following prompts to list consumer organization:
Table 2. Prompts
| Action and command |
Prompts |
List consumer organizations/list_consumer_orgs
|
list consumer organizations
list consumer orgs with limit 30
list consumer orgs with offset 15
list consumer orgs with limit 10 and offset 3
I would like to get the consumer orgs in API Connect provider organization using limit 50 and offset 20
list consumer orgs in catalog xyz
list consumer orgs in catalog with name testing2
list consumer orgs from catalog abcd with limit 30
list consumer orgs with limit 10 and offset 3 and in catalog with name test-catalog
get me the consumer orgs in API Connect provider organization catalog staging and using limit 10
|
List applications in catalog
Lists the consumer applications (apps) in the catalog. It takes the catalog name as input and
returns all the consumer applications (apps) from that catalog.
Table 3. Parameters
| Field name |
Type |
Default value |
Description |
| Catalog |
String |
Sandbox |
ID or name of the catalog from which the consumer apps are listed. |
consumer_org (optional field) |
String |
No applicable |
If valid, filters the consumer apps output list by using this value of the consumer
org. |
| Limit (optional) |
Integer |
100 |
Maximum number of rows to return |
| Skip (optional) |
Integer |
0 |
Skip this number of rows and return the remaining rows according to the limit set |
You can use the following prompts to list consumer organization:
Table 4. Prompts
| Action and command |
Prompts |
List applications in catalog/list_consumer_apps
|
list apps
list applications
list consumer applications
list apps in catalog
list apps with limit 30
list apps in catalog with limit 50
list apps in catalog with offset 15
list apps in catalog with limit 10 and offset 3
get me all the apps in catalog test-catalog with limit 10 and offset 3
I would like to get the consumer applications in API Connect provider organization using limit 50 and offset 20
list applications with limit 5
list applications with limit 5 and catalog test-catalog
|
List consumer application credentials
Lists consumer application (app) credentials operation. It takes the catalog name, consumer org,
and consumer app as input and returns all the consumer app credentials for the input data.
Table 5. Parameters
| Field name |
Type |
Default value |
Description |
consumer_app_name |
String |
Not applicable |
Name of the consumer application (app) from which credentials are listed. This app must
belong to the specified catalog or consumer_org. |
consumer_org |
String |
Not applicable |
Name of the consumer org from which app credentials are listed. This consumer org must belong
to the specified catalog. |
| Catalog |
String |
Sandbox |
Name of the catalog from which the consumer app credentials are listed. The consumer org and
consumer app belong to this catalog. |
You can use the following prompts to create a consumer application credential:
Table 6. Prompts
| Action and command |
Prompts |
List consumer application
credential/list_consumer_app_credentials
|
list consumer app credentials for consumer app test-app and consumer org test-org
list consumer app credentials for consumer app test-app and consumer org test-org from catalog test
I would like to get the consumer application credentials in API Connect provider organization for catalog c1-staging and consumer org myorg and consumer application test-app
get me all the consumer app credentials for consumer app test-app and consumer org test-org
list me all the consumer app credentials in catalog test-catalog and consumer app myapp and consumer org myorg
|
List subscription in catalog
Lists subscriptions in a catalog in an IBM
API Connect instance provider
organization. Returns all the subscriptions in the catalog that match the input data.
Table 7. Parameters
| Field name |
Type |
Default value |
Description |
| Catalog |
String |
Sandbox |
ID or name of the catalog from which the subscriptions are listed. |
plan_name (optional) |
String |
Not applicable |
Name of the plan. If not None, filters the subscriptions by the plan name |
consumer_org (optional) |
String |
Not applicable |
Name of the consumer org. If not None, filters the subscriptions by the given consumer org
name |
product_name (optional) |
String |
Not applicable |
Name or name: version of the product. If not None, filters the subscriptions by the given
product information. |
| Limit (optional) |
Integer |
100 |
Maximum number of rows to return. |
| Skip (optional) |
Integer |
0 |
Skip this number of rows and return the remaining rows according to the limit set. |
You can use following prompts to list subscriptions:
Table 8. Prompts
| Action and command |
Prompts |
List subscription in
catalog/list_subscriptions_in_a_catalog
|
list subscriptions
list subscriptions with limit 10
list subscriptions with limit 10 and offset 5
I would like to get the subscriptions in API Connect provider organization using limit 20 and offset 10
list subscriptions in catalog xyz
list subscriptions in catalog with name abcd
list subscriptions with limit 10 and offset 5 from catalog with name testing2
get me the subscriptions in API Connect provider organization catalog staging and with limit 20
list subscriptions in catalog abcd1 and filter by plan myplan
list subscriptions in catalog abcd2 and filter by consumer org test-org
list subscriptions in catalog abcd3 and filter by product product1
list subscriptions in catalog sandbox and filter by plan myplan and consumer org test-org and product product1:1.0.0
|
List subscription in consumer application
Lists subscriptions in a consumer application (app) in an IBM
API Connect instance provider
organization. Returns all the subscriptions in the consumer application that match the input
data.
Table 9. Parameters
| Field name |
Type |
Default value |
Description |
| Catalog |
String |
Sandbox |
ID or name of the catalog from which the subscriptions are listed. |
consumer_org |
String |
Not applicable |
The name of the consumer org that is part of the catalog given. |
consumer_app |
String |
Not applicable |
The name of the consumer app, which is part of the consumer is org that is given. |
plan_name (optional) |
String |
Not applicable |
Name of the plan. If not None, filters the subscriptions by the plan name. |
product_name (optional) |
String |
Not applicable |
Name or name: version of the product. If not None, filters the subscriptions by the given
product information. |
| Limit (optional) |
Integer |
100 |
Maximum number of rows to return. |
| Skip (optional) |
Integer |
0 |
Skip this number of rows and return the remaining rows according to the limit set. |
You can use following prompts to list subscriptions:
Table 10. Prompts
| Action and command |
Prompts |
List subscription in consumer
application/list_subscriptions_in_consumer_app
|
list subscriptions in consumer org test-org and consumer app test-app
list subscriptions in consumer org test-org and consumer application test-app with limit 5
list subscriptions in consumer org with name test-org and consumer app test-app with offset 3
list subscriptions in consumer org test-org and consumer app test-app with limit 15 and offset 5
I would like to get the subscriptions in consumer org myorg and consumer app myapp using limit 20 and offset 10
get me the subscriptions in API Connect provider organization with consumer org corg and consumer application myapp and limit 10
list subscriptions in catalog test-catalog and consumer org test-org and consumer app test-app
list subscriptions in catalog test-catalog and consumer org test-org and consumer application test-app with limit 5
list subscriptions in catalog test-catalog and consumer org test-org and consumer app test-app with offset 3
list subscriptions in catalog with name test-catalog and consumer org test-org and consumer app test-app with limit 15 and offset 5
I would like to get the subscriptions in catalog test-catalog and consumer org myorg and consumer app myapp using limit 20 and offset 10
get me the subscriptions in API Connect provider organization in catalog test-catalog and consumer org corg and consumer application myapp and limit 10
|
Create consumer application
The created consumer application creates a consumer application in the specified catalog for a
specific consumer organization in the IBM
API Connect instance. User
confirmation is required before this operation can proceed.
Table 11. Parameters
| Field name |
Type |
Default value |
Description |
| Title |
String |
Not applicable |
Title of the consumer application(app). This app gets created under the specified
catalog/consumer_org |
consumer_org |
String |
Not applicable |
Name of the consumer org in which the consumer app is created. This consumer org must belong
to the specified catalog |
| Catalog |
String |
Sandbox |
The name of the catalog in which to create the consumer application. If not
specified. |
You can use the following prompts to create a consumer application:
Table 12. Prompts
| Action and command |
Prompts |
Create a consumer app/create_consumer_app
|
create consumer app with title myapp in consumer org test-org
create consumer app with title test-app in consumer org test-org and catalog test
I would like to create a consumer application with title my-consumer-app in API Connect provider organization for catalog c1-staging and consumer org myorg
create consumer application with title test app in consumer org test-org
|
Create subscription for an API
Creates a subscription for a published API. This operation takes the catalog name, consumer
organization name, consumer application name, API name or version, and plan name as input, and
subscribes the consumer application to the specified plan in the API or product.
Table 13. Parameters
| Field name |
Type |
Default value |
Description |
api_name |
String |
Not applicable |
The name of the published API for which a subscription gets created. It can be of the formats
API_NAME or API_NAME:VERSION |
consumer_app_name (optional) |
String |
Not applicable |
The name of the consumer application. If not specified, and only one consumer application
exists in the system, that application is used by default. |
consumer_org (optional) |
String |
Not applicable |
Name of the consumer org in which the subscription is created. |
plan_name (optional) |
String |
Not applicable |
The subscription is created for this plan. The plan must be part of the published API 1. If
no plan is given in the input and the published API has just one plan, then that plan is used to
create the subscription. 2. If no plan given in the input and multiple plans available in the API
then error is displayed |
| Catalog |
String |
Sandbox |
Name of the catalog where the APIs present for which the subscription is created. |
You can use following prompts to create a subscription:
Table 14. Prompts
| Action and command |
Prompts |
Create subscription for an
API/create_subscription_for_published_api
|
create subscription for api test_api1
I would like to subscribe to the api with name api-test:1.0.1
create subscription in catalog stage-catalog for api test_api1
I would like to subscribe to the api with name api-test:1.0.1 in catalog stage-catalog
create subscription for api test_api1 and consumer org myorg
I would like to subscribe to the api with name api-test:1.0.1 and consumer org myorg
create subscription in catalog stage-catalog for api test_api1 and consumer org myorg
I would like to subscribe to the api with name api-test:1.0.1 in catalog stage-catalog and consumer org myorg
create subscription for api test_api1 and consumer org myorg and consumer app myapp
I would like to subscribe to the api with name api-test:1.0.1 and consumer org myorg and consumer app myapp
create subscription in catalog stage-catalog for api test_api1 and consumer org myorg and consumer app myapp
I would like to subscribe to the api with name api-test:1.0.1 in catalog stage-catalog and consumer org myorg and consumer app myapp
|
Create subscription for a product
Creates a subscription for a published product. It takes catalog name, consumer org name,
consumer app name, the product name, or version and plan name as input and subscribes the consumer
app to the plan present in the product.
Table 15. Parameters
| Field name |
Type |
Default value |
Description |
product_name |
String |
Not applicable |
Name of the published product for which a subscription is created. It can be of the formats
PRODUCT_NAME or PRODUCT_NAME:VERSION |
| Catalog |
String |
Sandbox |
Name of the catalog where the product is present for which the subscription is
created. |
consumer_org (optional) |
String |
Not applicable |
Name of the consumer application(app) present in the consumer org for which the subscription
is created |
plan_name (optional) |
String |
Not applicable |
The subscription is created for this plan. The plan must be part of the published product 1.
If no plan is given in the input and the published product has just one plan, then that plan is used
to create the subscription. 2. If no plan given in the input and multiple plans available in the
product then error is displayed. |
You can use following prompts to create a subscription for a product:
Table 16. Prompts
| Action and command |
Prompts |
Create subscription for a
product/create_subscription_for_published_product
|
create subscription for product testproduct1
I would like to subscribe to the product with name testproduct2:1.0.1
create subscription in catalog stage-catalog for product product1
I would like to subscribe to the product with name my-product1 in catalog stage-catalog
create subscription for product product1 and consumer org myorg
I would like to subscribe to the product with name prod-test:1.0.1 and consumer org myorg
create subscription in catalog stage-catalog for product prodtest and consumer org myorg
I would like to subscribe to the product with name prod-test:1.0.1 and consumer org myorg and consumer app myapp
create subscription in catalog stage-catalog for product prodtest and consumer org myorg and consumer app myapp
I would like to subscribe to the plan default-plan in the product with name prod-test:1.0.1
create subscription in catalog stage-catalog for plan plan1 in product prodtest
I would like to subscribe to the plan plan1 in the product with name prod-test:1.0.1 in catalog stage-catalog
|