Skip to main content
Kinetic Community

Kapps

Operation List

GET /kapps Retrieve Kapps
POST /kapps Create Kapp
GET /kapps/{slug} Retrieve Kapp
PUT /kapps/{slug} Update Kapp
DELETE /kapps/{slug} Delete Kapp

Resource Schema

Available Includes

  • details
  • attributes
  • categories
  • categorizations
  • categoryAttributeDefinitions
  • formAttributeDefinitions
  • forms
  • kappAttributeDefinitions
  • securityPolicyDefinitions
  • securityPolicies
  • space
  • webhooks

Operations

Retrieve Kapps

GET /kapps

Returns information about all Kapps for the specified Space.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "kapps": [
    {
      "name": "Catalog",
      "slug": "catalog",
      "afterLogoutPath": "",
      "bundlePath": "catalog",
      "defaultFormConfirmationPage": "confirmation.jsp",
      "defaultFormDisplayPage": "form.jsp",
      "defaultSubmissionLabelExpression": "${submission.id}",
      "displayType": "Display Page",
      "displayValue": "kapp.jsp",
      "loginPage": "login.jsp",
      "attributes": [],
      "categories": [],
      "categorizations": [],
      "categoryAttributeDefinitions": [],
      "fields": [],
      "formAttributeDefinitions": [],
      "formTypes": [],
      "forms": [],
      "kappAttributeDefinitions": [],
      "securityPolicies": [],
      "securityPolicyDefinitions": [],
      "webhooks": []
    }
  ]
}

Create Kapp

POST /kapps

Creates a new kapp for the Space.

The user must have Space management privileges to perform this action.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Catalog",
  "slug": "catalog",
  "afterLogoutPath": "",
  "bundlePath": "catalog",
  "defaultFormConfirmationPage": "confirmation.jsp",
  "defaultFormDisplayPage": "form.jsp",
  "defaultSubmissionLabelExpression": "${submission.id}",
  "displayType": "Display Page",
  "displayValue": "kapp.jsp",
  "loginPage": "login.jsp",
  "attributes": [],
  "categories": [],
  "categorizations": [],
  "categoryAttributeDefinitions": [],
  "fields": [],
  "formAttributeDefinitions": [],
  "formTypes": [],
  "forms": [],
  "kappAttributeDefinitions": [],
  "securityPolicies": [],
  "securityPolicyDefinitions": [],
  "webhooks": []
}

Response

Body
{
  "kapp": {
    "name": "Catalog",
    "slug": "catalog",
    "afterLogoutPath": "",
    "bundlePath": "catalog",
    "defaultFormConfirmationPage": "confirmation.jsp",
    "defaultFormDisplayPage": "form.jsp",
    "defaultSubmissionLabelExpression": "${submission.id}",
    "displayType": "Display Page",
    "displayValue": "kapp.jsp",
    "loginPage": "login.jsp",
    "attributes": [],
    "categories": [],
    "categorizations": [],
    "categoryAttributeDefinitions": [],
    "fields": [],
    "formAttributeDefinitions": [],
    "formTypes": [],
    "forms": [],
    "kappAttributeDefinitions": [],
    "securityPolicies": [],
    "securityPolicyDefinitions": [],
    "webhooks": []
  }
}

Retrieve Kapp

GET /kapps/{slug}

Retrieves the Kapp identified by the {slug} parameter.

Request

Path Parameters
slug

The slug of the kapp to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "kapp": {
    "name": "Catalog",
    "slug": "catalog",
    "afterLogoutPath": "",
    "bundlePath": "catalog",
    "defaultFormConfirmationPage": "confirmation.jsp",
    "defaultFormDisplayPage": "form.jsp",
    "defaultSubmissionLabelExpression": "${submission.id}",
    "displayType": "Display Page",
    "displayValue": "kapp.jsp",
    "loginPage": "login.jsp",
    "attributes": [],
    "categories": [],
    "categorizations": [],
    "categoryAttributeDefinitions": [],
    "fields": [],
    "formAttributeDefinitions": [],
    "formTypes": [],
    "forms": [],
    "kappAttributeDefinitions": [],
    "securityPolicies": [],
    "securityPolicyDefinitions": [],
    "webhooks": []
  }
}

Update Kapp

PUT /kapps/{slug}

Updates the Kapp specified by the {slug} 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.

The user must have Space management privileges to perform this action.

Request

Path Parameters
slug

The slug of the kapp to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "Catalog",
  "slug": "catalog",
  "afterLogoutPath": "",
  "bundlePath": "catalog",
  "defaultFormConfirmationPage": "confirmation.jsp",
  "defaultFormDisplayPage": "form.jsp",
  "defaultSubmissionLabelExpression": "${submission.id}",
  "displayType": "Display Page",
  "displayValue": "kapp.jsp",
  "loginPage": "login.jsp",
  "attributes": [],
  "categories": [],
  "categorizations": [],
  "categoryAttributeDefinitions": [],
  "fields": [],
  "formAttributeDefinitions": [],
  "formTypes": [],
  "forms": [],
  "kappAttributeDefinitions": [],
  "securityPolicies": [],
  "securityPolicyDefinitions": [],
  "webhooks": []
}

Response

Body
{
  "kapp": {
    "name": "Catalog",
    "slug": "catalog",
    "afterLogoutPath": "",
    "bundlePath": "catalog",
    "defaultFormConfirmationPage": "confirmation.jsp",
    "defaultFormDisplayPage": "form.jsp",
    "defaultSubmissionLabelExpression": "${submission.id}",
    "displayType": "Display Page",
    "displayValue": "kapp.jsp",
    "loginPage": "login.jsp",
    "attributes": [],
    "categories": [],
    "categorizations": [],
    "categoryAttributeDefinitions": [],
    "fields": [],
    "formAttributeDefinitions": [],
    "formTypes": [],
    "forms": [],
    "kappAttributeDefinitions": [],
    "securityPolicies": [],
    "securityPolicyDefinitions": [],
    "webhooks": []
  }
}

Delete Kapp

DELETE /kapps/{slug}

Deletes the Kapp specified by the {slug} parameter.

The user must have Space management privileges to perform this action.

Request

Path Parameters
slug

The slug of the kapp to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "kapp": {
    "name": "Catalog",
    "slug": "catalog",
    "afterLogoutPath": "",
    "bundlePath": "catalog",
    "defaultFormConfirmationPage": "confirmation.jsp",
    "defaultFormDisplayPage": "form.jsp",
    "defaultSubmissionLabelExpression": "${submission.id}",
    "displayType": "Display Page",
    "displayValue": "kapp.jsp",
    "loginPage": "login.jsp",
    "attributes": [],
    "categories": [],
    "categorizations": [],
    "categoryAttributeDefinitions": [],
    "fields": [],
    "formAttributeDefinitions": [],
    "formTypes": [],
    "forms": [],
    "kappAttributeDefinitions": [],
    "securityPolicies": [],
    "securityPolicyDefinitions": [],
    "webhooks": []
  }
}

 

Related