Skip to main content
Kinetic Community

Attribute Definitions

  1. Operation List
  2. Resource Schema
    1. Available Includes
  3. Operations
    1. Retrieve Space Attribute Definitions
      1. Request
        1. Query Parameters
      2. Response
        1. Body
    2. Create Space Attribute Definition
      1. Request
        1. Query Parameters
        2. Body
      2. Response
        1. Body
    3. Retrieve Space Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    4. Update Space Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    5. Delete Space Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    6. Retrieve User Attribute Definitions
      1. Request
        1. Query Parameters
      2. Response
        1. Body
    7. Create User Attribute Definition
      1. Request
        1. Query Parameters
        2. Body
      2. Response
        1. Body
    8. Retrieve User Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    9. Update User Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    10. Delete User Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    11. Retrieve Category Attribute Definitions
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    12. Create Category Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    13. Retrieve Category Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    14. Update Category Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    15. Delete Category Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    16. Retrieve Form Attribute Definitions
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    17. Create Form Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    18. Retrieve Form Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    19. Update Form Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    20. Delete Form Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    21. Retrieve Kapp Attribute Definitions
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    22. Create Kapp Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    23. Retrieve Kapp Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
    24. Update Kapp Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
        3. Body
      2. Response
        1. Body
    25. Delete Kapp Attribute Definition
      1. Request
        1. Path Parameters
        2. Query Parameters
      2. Response
        1. Body
  4. Related

An attribute definition contains metadata for an attribute that may apply to a component within Kinetic Request CE. The attribute definition is attached to either a Space or a Kapp, and contains the name of the attribute, the component it applies to (Space, Kapp, User, Form, Category), and whether the attribute may contain multiple values or is simply a single value.

Operation List

GET /spaceAttributeDefinitions Retrieve Space Attribute Definitions
POST /spaceAttributeDefinitions Create Space Attribute Definition
GET /spaceAttributeDefinitions/{name} Retrieve Space Attribute Definition
PUT /spaceAttributeDefinitions/{name} Update Space Attribute Definition
DELETE /spaceAttributeDefinitions/{name} Delete Space Attribute Definition
GET /userAttributeDefinitions Retrieve User Attribute Definitions
POST /userAttributeDefinitions Create User Attribute Definition
GET /userAttributeDefinitions/{name} Retrieve User Attribute Definition
PUT /userAttributeDefinitions/{name} Update User Attribute Definition
DELETE /userAttributeDefinitions/{name} Delete User Attribute Definition
GET /kapps/{kappSlug}/categoryAttributeDefinitions Retrieve Category Attribute Definitions
POST /kapps/{kappSlug}/categoryAttributeDefinitions Create Category Attribute Definition
GET /kapps/{kappSlug}/categoryAttributeDefinitions/{name} Retrieve Category Attribute Definition
PUT /kapps/{kappSlug}/categoryAttributeDefinitions/{name} Update Category Attribute Definition
DELETE /kapps/{kappSlug}/categoryAttributeDefinitions/{name} Delete Category Attribute Definition
GET /kapps/{kappSlug}/formAttributeDefinitions Retrieve Form Attribute Definitions
POST /kapps/{kappSlug}/formAttributeDefinitions Create Form Attribute Definition
GET /kapps/{kappSlug}/formAttributeDefinitions/{name} Retrieve Form Attribute Definition
PUT /kapps/{kappSlug}/formAttributeDefinitions/{name} Update Form Attribute Definition
DELETE /kapps/{kappSlug}/formAttributeDefinitions/{name} Delete Form Attribute Definition
GET /kapps/{kappSlug}/kappAttributeDefinitions Retrieve Kapp Attribute Definitions
POST /kapps/{kappSlug}/kappAttributeDefinitions Create Kapp Attribute Definition
GET /kapps/{kappSlug}/kappAttributeDefinitions/{name} Retrieve Kapp Attribute Definition
PUT /kapps/{kappSlug}/kappAttributeDefinitions/{name} Update Kapp Attribute Definition
DELETE /kapps/{kappSlug}/kappAttributeDefinitions/{name} Delete Kapp Attribute Definition

Resource Schema

Available Includes

  • details

Operations

Retrieve Space Attribute Definitions

GET /spaceAttributeDefinitions

Returns information about all Space Attribute Definitions.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "spaceAttributeDefinitions": [
    {
      "allowsMultiple": false,
      "name": "Foo"
    }
  ]
}

Create Space Attribute Definition

POST /spaceAttributeDefinitions

Creates a new Space Attribute Definition.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "spaceAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve Space Attribute Definition

GET /spaceAttributeDefinitions/{name}

Retrieves the Space Attribute Definition identified by the {name} parameter.

Request

Path Parameters
name

The name of the attribute definition to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "spaceAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Update Space Attribute Definition

PUT /spaceAttributeDefinitions/{name}

Updates the Space Attribute Definition 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
name

The name of the attribute definition to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "spaceAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Delete Space Attribute Definition

DELETE /spaceAttributeDefinitions/{name}

Deletes the Space Attribute Definition specified by the {name} parameter.

Request

Path Parameters
name

The name of the attribute definition to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "spaceAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve User Attribute Definitions

GET /userAttributeDefinitions

Returns information about all User Attribute Definitions.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "userAttributeDefinitions": [
    {
      "allowsMultiple": false,
      "name": "Foo"
    }
  ]
}

Create User Attribute Definition

POST /userAttributeDefinitions

Creates a new User Attribute Definition.

Request

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "userAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve User Attribute Definition

GET /userAttributeDefinitions/{name}

Retrieves the User Attribute Definition identified by the {name} parameter.

Request

Path Parameters
name

The name of the attribute definition to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "userAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Update User Attribute Definition

PUT /userAttributeDefinitions/{name}

Updates the User Attribute Definition 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
name

The name of the attribute definition to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "userAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Delete User Attribute Definition

DELETE /userAttributeDefinitions/{name}

Deletes the User Attribute Definition specified by the {name} parameter.

Request

Path Parameters
name

The name of the attribute definition to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "userAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve Category Attribute Definitions

GET /kapps/{kappSlug}/categoryAttributeDefinitions

Returns information about all Category Attribute Definitions for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "categoryAttributeDefinitions": [
    {
      "allowsMultiple": false,
      "name": "Foo"
    }
  ]
}

Create Category Attribute Definition

POST /kapps/{kappSlug}/categoryAttributeDefinitions

Creates a new Category Attribute Definition for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "categoryAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve Category Attribute Definition

GET /kapps/{kappSlug}/categoryAttributeDefinitions/{name}

Retrieves the Category Attribute Definition identified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

name

The name of the attribute definition to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "categoryAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Update Category Attribute Definition

PUT /kapps/{kappSlug}/categoryAttributeDefinitions/{name}

Updates the Category Attribute Definition 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 attribute definition belongs to.

name

The name of the attribute definition to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "categoryAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

 

Delete Category Attribute Definition

DELETE /kapps/{kappSlug}/categoryAttributeDefinitions/{name}

Deletes the Category Attribute Definition specified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

name

The name of the attribute definition to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "categoryAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve Form Attribute Definitions

GET /kapps/{kappSlug}/formAttributeDefinitions

Returns information about all Form Attribute Definitions for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "formAttributeDefinitions": [
    {
      "allowsMultiple": false,
      "name": "Foo"
    }
  ]
}

Create Form Attribute Definition

POST /kapps/{kappSlug}/formAttributeDefinitions

Creates a new Form Attribute Definition for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "formAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve Form Attribute Definition

GET /kapps/{kappSlug}/formAttributeDefinitions/{name}

Retrieves the Form Attribute Definition identified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

name

The name of the attribute definition to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "formAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Update Form Attribute Definition

PUT /kapps/{kappSlug}/formAttributeDefinitions/{name}

Updates the Form Attribute Definition 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 attribute definition belongs to.

name

The name of the attribute definition to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "formAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Delete Form Attribute Definition

DELETE /kapps/{kappSlug}/formAttributeDefinitions/{name}

Deletes the Form Attribute Definition specified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

name

The name of the attribute definition to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "formAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve Kapp Attribute Definitions

GET /kapps/{kappSlug}/kappAttributeDefinitions

Returns information about all Kapp Attribute Definitions for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "kappAttributeDefinitions": [
    {
      "allowsMultiple": false,
      "name": "Foo"
    }
  ]
}

Create Kapp Attribute Definition

POST /kapps/{kappSlug}/kappAttributeDefinitions

Creates a new Kapp Attribute Definition for the parent Kapp.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "kappAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Retrieve Kapp Attribute Definition

GET /kapps/{kappSlug}/kappAttributeDefinitions/{name}

Retrieves the Kapp Attribute Definition identified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

name

The name of the attribute definition to retrieve.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "kappAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Update Kapp Attribute Definition

PUT /kapps/{kappSlug}/kappAttributeDefinitions/{name}

Updates the Kapp Attribute Definition 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 attribute definition belongs to.

name

The name of the attribute definition to update.

Query Parameters
include

comma-separated list of properties to include in the response

Body
{
  "allowsMultiple": false,
  "name": "Foo"
}

Response

Body
{
  "kappAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

 

Delete Kapp Attribute Definition

DELETE /kapps/{kappSlug}/kappAttributeDefinitions/{name}

Deletes the Kapp Attribute Definition specified by the {name} parameter.

Request

Path Parameters
kappSlug

The slug of the Kapp that the attribute definition belongs to.

name

The name of the attribute definition to delete.

Query Parameters
include

comma-separated list of properties to include in the response

Response

Body
{
  "kappAttributeDefinition": {
    "allowsMultiple": false,
    "name": "Foo"
  }
}

Related