Skip to main content
Kinetic Community

Categorizations

Operation List

GET /kapps/{kappSlug}/categorizations Retrieve Categorizations
POST /kapps/{kappSlug}/categorizations Create Categorization
GET /kapps/{kappSlug}/categorizations/{categorySlug_formSlug} Retrieve Categorization
PUT /kapps/{kappSlug}/categorizations/{categorySlug_formSlug} Update Categorization
DELETE /kapps/{kappSlug}/categorizations/{categorySlug_formSlug} Delete Categorization

Resource Schema

Available Includes

  • details
  • attributes
  • category
  • form
  • kapp

Operations

Retrieve Categorizations

GET /kapps/{kappSlug}/categorizations

Returns information about all Categorizations for the specified Kapp. A categorization is a relationship between a Category and a Form.

Request

Path Parameters
kappSlug

The slug of the Kapp that the categorization belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "categorizations": [
    {
      "category": "Foo",
      "form": "bar"
    }
  ]
}

Create Categorization

POST /kapps/{kappSlug}/categorizations

Creates a new categorization for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the categorization belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "category": "Foo",
  "form": "bar"
}

Response

Body
{
  "categorization": {
    "category": "Foo",
    "form": "bar"
  }
}

Retrieve Categorization

GET /kapps/{kappSlug}/categorizations/{categorySlug_formSlug}

Retrieves the Categorization identified by the {categorySlug_formSlug} parameter.

The {categorySlug_formSlug} parameter is a combination of the category slug and the form slug the categorization represents.

Request

Path Parameters
kappSlug

The slug of the Kapp that the Categorization belongs to.

categorySlug_formSlug

The concatenated form slug and category name to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "categorization": {
    "category": "Foo",
    "form": "bar"
  }
}

Update Categorization

PUT /kapps/{kappSlug}/categorizations/{categorySlug_formSlug}

Updates the Categorization specified by the {categorySlug_formSlug} parameter with the property values sent in the request body.

The {categorySlug_formSlug} parameter is a combination of the form slug and the category name the categorization represents.

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 Categorization belongs to.

categorySlug_formSlug

The concatenated form slug and category name to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "category": "Foo",
  "form": "bar"
}

Response

Body
{
  "categorization": {
    "category": "Foo",
    "form": "bar"
  }
}

Delete Categorization

DELETE /kapps/{kappSlug}/categorizations/{categorySlug_formSlug}

Deletes the Categorization specified by the {categorySlug_formSlug} parameter.

The {categorySlug_formSlug} parameter is a combination of the form slug and the category name the categorization represents.

Request

Path Parameters
kappSlug

The slug of the Kapp that the categorization belongs to.

categorySlug_formSlug

The concatenated form slug and category name of the categorization to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "categorization": {
    "category": "Foo",
    "form": "bar"
  }
}

 

Related