apicategories

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

Overview

Name	apicategories
Type	Resource
Id	google.apigee.apicategories

Fields

The following fields are returned by SELECT queries:

organizations_sites_apicategories_get

Successful response

Name	Datatype	Description
data	object	The API category resource. (id: GoogleCloudApigeeV1ApiCategory)
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.

organizations_sites_apicategories_list

Successful response

Name	Datatype	Description
data	array	The API category resources.
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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_sites_apicategories_get	select	organizationsId, sitesId, apicategoriesId		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_patch	update	organizationsId, sitesId, apicategoriesId		Updates an API category.
organizations_sites_apicategories_delete	delete	organizationsId, sitesId, apicategoriesId		Deletes an API category.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
apicategoriesId	string
organizationsId	string
sitesId	string

SELECT examples

organizations_sites_apicategories_get

Gets an API category.

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

organizations_sites_apicategories_list

Returns the API categories associated with a portal.

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

INSERT examples

organizations_sites_apicategories_create

Creates a new API category.

INSERT INTO google.apigee.apicategories (
data__siteId,
data__name,
data__id,
data__updateTime,
organizationsId,
sitesId
)
SELECT 
'{{ siteId }}',
'{{ name }}',
'{{ id }}',
'{{ updateTime }}',
'{{ organizationsId }}',
'{{ sitesId }}'
RETURNING
data,
errorCode,
message,
requestId,
status
;

Manifest

# Description fields are for documentation purposes
- name: apicategories
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the apicategories resource.
    - name: sitesId
      value: string
      description: Required parameter for the apicategories resource.
    - name: siteId
      value: string
      description: >
        Name of the portal.
        
    - name: name
      value: string
      description: >
        Name of the category.
        
    - name: id
      value: string
      description: >
        ID of the category (a UUID).
        
    - name: updateTime
      value: string
      description: >
        Time the category was last modified in milliseconds since epoch.
        

UPDATE examples

organizations_sites_apicategories_patch

Updates an API category.

UPDATE google.apigee.apicategories
SET 
data__siteId = '{{ siteId }}',
data__name = '{{ name }}',
data__id = '{{ id }}',
data__updateTime = '{{ updateTime }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND sitesId = '{{ sitesId }}' --required
AND apicategoriesId = '{{ apicategoriesId }}' --required
RETURNING
data,
errorCode,
message,
requestId,
status;

DELETE examples

organizations_sites_apicategories_delete

Deletes an API category.

DELETE FROM google.apigee.apicategories
WHERE organizationsId = '{{ organizationsId }}' --required
AND sitesId = '{{ sitesId }}' --required
AND apicategoriesId = '{{ apicategoriesId }}' --required;