Apigee API . organizations . sites . apicategories

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new API category.

Args:
  parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
  body: object, The request body.
    The object takes the form of:

{ # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.
  "id": "A String", # ID of the category (a UUID).
  "name": "A String", # Name of the category.
  "siteId": "A String", # Name of the portal.
  "updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The API category resource wrapped with response status, error_code, etc.
  "data": { # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category. # The API category resource.
    "id": "A String", # ID of the category (a UUID).
    "name": "A String", # Name of the category.
    "siteId": "A String", # Name of the portal.
    "updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
  },
  "errorCode": "A String", # Unique error code for the request, if any.
  "message": "A String", # Description of the operation.
  "requestId": "A String", # Unique ID of the request.
  "status": "A String", # Status of the operation.
}

delete(name, x__xgafv=None)

Deletes an API category.

Args:
  name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for certain delete operations.
  "errorCode": "A String", # Unique error code for the request, if any.
  "gcpResource": "A String", # Google Cloud name of deleted resource.
  "message": "A String", # Description of the operation.
  "requestId": "A String", # Unique ID of the request.
  "status": "A String", # Status of the operation.
}

get(name, x__xgafv=None)

Gets an API category.

Args:
  name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The API category resource wrapped with response status, error_code, etc.
  "data": { # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category. # The API category resource.
    "id": "A String", # ID of the category (a UUID).
    "name": "A String", # Name of the category.
    "siteId": "A String", # Name of the portal.
    "updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
  },
  "errorCode": "A String", # Unique error code for the request, if any.
  "message": "A String", # Description of the operation.
  "requestId": "A String", # Unique ID of the request.
  "status": "A String", # Status of the operation.
}

list(parent, x__xgafv=None)

Returns the API categories associated with a portal.

Args:
  parent: string, Required. Name of the portal. Use the following structure in your request: `organizations/{org}/sites/{site}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response for `ListApiCategoriesRequest`. Next ID: 6
  "data": [ # The API category resources.
    { # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.
      "id": "A String", # ID of the category (a UUID).
      "name": "A String", # Name of the category.
      "siteId": "A String", # Name of the portal.
      "updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
    },
  ],
  "errorCode": "A String", # Unique error code for the request, if any.
  "message": "A String", # Description of the operation.
  "requestId": "A String", # Unique ID of the request.
  "status": "A String", # Status of the operation.
}

patch(name, body=None, x__xgafv=None)

Updates an API category.

Args:
  name: string, Required. Name of the category. Use the following structure in your request: `organizations/{org}/sites/{site}/apicategories/{apicategory}` (required)
  body: object, The request body.
    The object takes the form of:

{ # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category.
  "id": "A String", # ID of the category (a UUID).
  "name": "A String", # Name of the category.
  "siteId": "A String", # Name of the portal.
  "updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The API category resource wrapped with response status, error_code, etc.
  "data": { # `ApiCategory` represents an API category. [Catalog items](/apigee/docs/reference/apis/apigee/rest/v1/organizations.sites.apidocs) can be tagged with API categories; users viewing the API catalog in the portal will have the option to browse the catalog by category. # The API category resource.
    "id": "A String", # ID of the category (a UUID).
    "name": "A String", # Name of the category.
    "siteId": "A String", # Name of the portal.
    "updateTime": "A String", # Time the category was last modified in milliseconds since epoch.
  },
  "errorCode": "A String", # Unique error code for the request, if any.
  "message": "A String", # Description of the operation.
  "requestId": "A String", # Unique ID of the request.
  "status": "A String", # Status of the operation.
}