Skip to main content
Kinetic Community

Form Types

Operation List

GET /kapps/{kappSlug}/formTypes Retrieve Form Types
POST /kapps/{kappSlug}/formTypes Create Form Type
GET /kapps/{kappSlug}/formTypes/{name} Retrieve Form Type
PUT /kapps/{kappSlug}/formTypes/{name} Update Form Type
DELETE /kapps/{kappSlug}/formTypes/{name} Delete Form Type

Resource Schema

Available Includes

  • details
  • kapp

Operations

Retrieve Form Types

GET /kapps/{kappSlug}/formTypes

Returns information about all Form Types for the specified Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the form type belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "formTypes": [
    {
      "name": "Foo"
    }
  ]
}

Create Form Type

POST /kapps/{kappSlug}/formTypes

Creates a new form type for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the form type belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Foo"
}

Response

Body
{
  "formType": {
    "name": "Foo"
  }
}

Retrieve Form Type

GET /kapps/{kappSlug}/formTypes/{name}

Retrieves the Form Type identified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the form type belongs to.

name

The name of the form type to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "formType": {
    "name": "Foo"
  }
}

Update Form Type

PUT /kapps/{kappSlug}/formTypes/{name}

Updates the Form Type 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 form type belongs to.

name

The name of the form type to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Foo"
}

Response

Body
{
  "formType": {
    "name": "Foo"
  }
}

Delete Form Type

DELETE /kapps/{kappSlug}/formTypes/{name}

Deletes the Form Type specified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the form type belongs to.

name

The name of the form type to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "formType": {
    "name": "Foo"
  }
}

 

Related