Skip to main content
Kinetic Community

Categories

Operation List

GET /kapps/{kappSlug}/categories Retrieve Categories
POST /kapps/{kappSlug}/categories Create Category
GET /kapps/{kappSlug}/categories/{name} Retrieve Category
PUT /kapps/{kappSlug}/categories/{name} Update Category
DELETE /kapps/{kappSlug}/categories/{name} Delete Category

Resource Schema

Available Includes

  • details
  • attributes
  • categorizations
  • kapp

Operations

Retrieve Categories

GET /kapps/{kappSlug}/categories

Returns information about all Categories for the specified Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the category belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "categories": [
    {
      "name": "Foo",
      "attributes": []
    }
  ]
}

Create Category

POST /kapps/{kappSlug}/categories

Creates a new category for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the category belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Foo",
  "attributes": []
}

Response

Body
{
  "category": {
    "name": "Foo",
    "attributes": []
  }
}

Retrieve Category

GET /kapps/{kappSlug}/categories/{name}

Retrieves the Category identified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the category belongs to.

name

The name of the category to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "category": {
    "name": "Foo",
    "attributes": []
  }
}

Update Category

PUT /kapps/{kappSlug}/categories/{name}

Updates the Category specified by the {name} parameter with the property values sent in the request body.

NOTE All properties in the request body are optional, and only the properties supplied will be updated.

Request

Path Parameters
kappSlug

The slug of the Kapp that the category belongs to.

name

The name of the category to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Foo",
  "attributes": []
}

Response

Body
{
  "category": {
    "name": "Foo",
    "attributes": []
  }
}

Delete Category

DELETE /kapps/{kappSlug}/categories/{name}

Deletes the Category specified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the category belongs to.

name

The name of the category to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "category": {
    "name": "Foo",
    "attributes": []
  }
}

 

Related