apicategories

Creates, updates, deletes, gets or lists a apicategories resource.

Overview

Name	apicategories
Type	Resource
Id	google.apigee.apicategories

Fields

Name	Datatype	Description
data	object	ApiCategory represents an API category. Catalog items can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.
errorCode	string	Unique error code for the request, if any.
message	string	Description of the operation.
requestId	string	Unique ID of the request.
status	string	Status of the operation.

Methods

Name	Accessible by	Required Params	Description
organizations_sites_apicategories_get	SELECT	apicategoriesId, organizationsId, sitesId	Gets an API category.
organizations_sites_apicategories_list	SELECT	organizationsId, sitesId	Returns the API categories associated with a portal.
organizations_sites_apicategories_create	INSERT	organizationsId, sitesId	Creates a new API category.
organizations_sites_apicategories_delete	DELETE	apicategoriesId, organizationsId, sitesId	Deletes an API category.
organizations_sites_apicategories_patch	UPDATE	apicategoriesId, organizationsId, sitesId	Updates an API category.

SELECT examples

Returns the API categories associated with a portal.

SELECT
data,
errorCode,
message,
requestId,
status
FROM google.apigee.apicategories
WHERE organizationsId = '{{ organizationsId }}'
AND sitesId = '{{ sitesId }}';

INSERT example

Use the following StackQL query and manifest file to create a new apicategories resource.

All Properties

/*+ create */
INSERT INTO google.apigee.apicategories (
organizationsId,
sitesId,
name,
siteId
)
SELECT 
'{{ organizationsId }}',
'{{ sitesId }}',
'{{ name }}',
'{{ siteId }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: updateTime
      value: string
    - name: name
      value: string
    - name: siteId
      value: string
    - name: id
      value: string

UPDATE example

Updates a apicategories resource.

/*+ update */
UPDATE google.apigee.apicategories
SET 
name = '{{ name }}',
siteId = '{{ siteId }}'
WHERE 
apicategoriesId = '{{ apicategoriesId }}'
AND organizationsId = '{{ organizationsId }}'
AND sitesId = '{{ sitesId }}';

DELETE example

Deletes the specified apicategories resource.

/*+ delete */
DELETE FROM google.apigee.apicategories
WHERE apicategoriesId = '{{ apicategoriesId }}'
AND organizationsId = '{{ organizationsId }}'
AND sitesId = '{{ sitesId }}';