Skip to main content
Kinetic Community

Forms

Operation List

GET /kapps/{kappSlug}/forms Retrieve Forms
POST /kapps/{kappSlug}/forms Create Form
GET /kapps/{kappSlug}/forms/{formSlug} Retrieve Form
PUT /kapps/{kappSlug}/forms/{formSlug} Update Form
DELETE /kapps/{kappSlug}/forms/{formSlug} Delete Form
GET /kapps/{kappSlug}/forms/{formSlug}/export Export Form

Resource Schema

Available Includes

  • details
  • attributes
  • bridgedResources
  • categorizations
  • customHeadContent
  • fields
  • kapp
  • pages
  • securityPolicies

Operations

Retrieve Forms

GET /kapps/{kappSlug}/forms

Returns information about all Forms for the specified Kapp.

Request

Path Parameters
kappSlug

The slug of the kapp that the form resource belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "forms": [
    {
      "name": "iPad Request",
      "slug": "ipad-request",
      "anonymous": false,
      "description": "Request an iPad",
      "status": "Active",
      "type": "Service",
      "notes": "Notes",
      "submissionLabelExpression": null,
      "attributes": [],
      "bridgedResources": [],
      "categorizations": [],
      "customHeadContent": null,
      "fields": [],
      "kapp": {
        "name": "Catalog",
        "slug": "catalog"
      },
      "pages": [],
      "securityPolicies": []
    }
  ]
}

Create Form

POST /kapps/{kappSlug}/forms

Creates a new form for the Kapp.

The user must have Form creation privileges to perform this action.

Request

Path Parameters
kappSlug

The slug of the kapp that the form resource belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "iPad Request",
  "slug": "ipad-request",
  "anonymous": false,
  "description": "Request an iPad",
  "status": "Active",
  "type": "Service",
  "notes": "Notes",
  "submissionLabelExpression": null,
  "attributes": [],
  "bridgedResources": [],
  "categorizations": [],
  "customHeadContent": null,
  "fields": [],
  "kapp": {
    "name": "Catalog",
    "slug": "catalog"
  },
  "pages": [],
  "securityPolicies": []
}

Response

Body
{
  "form": {
    "name": "iPad Request",
    "slug": "ipad-request",
    "anonymous": false,
    "description": "Request an iPad",
    "status": "Active",
    "type": "Service",
    "notes": "Notes",
    "submissionLabelExpression": null,
    "attributes": [],
    "bridgedResources": [],
    "categorizations": [],
    "customHeadContent": null,
    "fields": [],
    "kapp": {
      "name": "Catalog",
      "slug": "catalog"
    },
    "pages": [],
    "securityPolicies": []
  }
}

Retrieve Form

GET /kapps/{kappSlug}/forms/{formSlug}

Retrieves the Form identified by the {formSlug} parameter.

Request

Path Parameters
kappSlug

The slug of the kapp that the form resource belongs to.

formSlug

The slug of the form resource.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "form": {
    "name": "iPad Request",
    "slug": "ipad-request",
    "anonymous": false,
    "description": "Request an iPad",
    "status": "Active",
    "type": "Service",
    "notes": "Notes",
    "submissionLabelExpression": null,
    "attributes": [],
    "bridgedResources": [],
    "categorizations": [],
    "customHeadContent": null,
    "fields": [],
    "kapp": {
      "name": "Catalog",
      "slug": "catalog"
    },
    "pages": [],
    "securityPolicies": []
  }
}

Update Form

PUT /kapps/{kappSlug}/forms/{formSlug}

Updates the Form specified by the {formSlug} 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 Form creation privileges to perform this action.

Request

Path Parameters
kappSlug

The slug of the kapp that the form resource belongs to.

formSlug

The slug of the form resource.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "name": "iPad Request",
  "slug": "ipad-request",
  "anonymous": false,
  "description": "Request an iPad",
  "status": "Active",
  "type": "Service",
  "attributes": [],
  "bridgedResources": [],
  "categorizations": [],
  "fields": [],
  "pages": [],
  "securityPolicies": []
}

Response

Body
{
  "form": {
    "name": "iPad Request",
    "slug": "ipad-request",
    "anonymous": false,
    "description": "Request an iPad",
    "status": "Active",
    "type": "Service",
    "notes": "Notes",
    "submissionLabelExpression": null,
    "attributes": [],
    "bridgedResources": [],
    "categorizations": [],
    "customHeadContent": null,
    "fields": [],
    "kapp": {
      "name": "Catalog",
      "slug": "catalog"
    },
    "pages": [],
    "securityPolicies": []
  }
}

Delete Form

DELETE /kapps/{kappSlug}/forms/{formSlug}

Deletes the Form specified by the {formSlug} parameter.

The user must have Form creation privileges to perform this action.

Request

Path Parameters
kappSlug

The slug of the kapp that the form resource belongs to.

formSlug

The slug of the form resource.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "form": {
    "name": "iPad Request",
    "slug": "ipad-request",
    "anonymous": false,
    "description": "Request an iPad",
    "status": "Active",
    "type": "Service",
    "notes": "Notes",
    "submissionLabelExpression": null,
    "attributes": [],
    "bridgedResources": [],
    "categorizations": [],
    "customHeadContent": null,
    "fields": [],
    "kapp": {
      "name": "Catalog",
      "slug": "catalog"
    },
    "pages": [],
    "securityPolicies": []
  }
}

Export Form

GET /kapps/{kappSlug}/forms/{formSlug}/export

Exports the Form identified by the {formSlug} parameter.

Request

Path Parameters
kappSlug

The slug of the kapp that the form resource belongs to.

formSlug

The slug of the form resource.

Response

Body
{
  "form": {
    "name": "iPad Request",
    "slug": "ipad-request",
    "anonymous": false,
    "description": "Request an iPad",
    "status": "Active",
    "type": "Service",
    "notes": "Notes",
    "submissionLabelExpression": null,
    "attributes": [],
    "bridgedResources": [],
    "categorizations": [],
    "customHeadContent": null,
    "pages": [],
    "securityPolicies": []
  }
}

 

Related