Type Management

Create Type

The createType operation in Contendo Server allows defining a new custom object type in the repository. This operation enables extending the repository's type system by introducing new object types with specific property definitions and behaviors.

Rules:

• general rules
• only added property definitions need to be defined. Inherited ones are automatically added.
• new base types can't be created - new types must have a parent.

curl -X 'POST' \
  '{REPOSITORY_URL}' \
  -H 'Content-Type: application/json' \
  -d '{
    "operation": "createType",
    "type": {
      "id": "dog",
      "localName": "dog",
      "displayName": "Dog",
      "description": "A document for dogs.",
      "baseId": "cmis:document",
      "parentId": "animal",
      "show": true,
      "propertyDefinitions": {
        "color": {
          "id": "color",
          "localName": "color",
          "displayName": "Color",
          "description": "Dog color",
          "propertyType": "string",
          "choices": [
            "White",
            "Brown",
            "Black",
            "Unknown"
          ],
          "openChoice": false,
          "defaultValue": "Unknown",
          "order": 10
        },
        "height": {
          "id": "height",
          "localName": "height",
          "displayName": "Height",
          "description": "Dog height",
          "propertyType": "integer",
          "required": true,
          "order": 20
        }
      }
    }
  }'

Get Type Definition

The typeDefinition operation in Contendo Server allows retrieving the full Type Definition for a single type. This operation provides detailed information about a type's attributes and property definitions, including inherited ones.

curl -X 'GET' \
 '{REPOSITORY_URL}?typeId=dog' 

Get Type Children

The typeChildren operation in Contendo Server retrieves the direct child types of a specified type. Alternatively it can also be used to retrieve all base types.

curl -X 'GET' \
  '{REPOSITORY_URL}?typeId=animal&includePropertyDefinitions=true&maxItems=2&skipCount=0'

{
  "types": [
    {
      "id": "dog",
      ...
    },
    {
      "id": "cat",
      ...
    }
  ],
  "numItems": 2,
  "hasMoreItems": false
}

Get Type Descendants

The typeDescendants operation in Contendo Server retrieves all descendant types of a specified type. Alternatively it can also be used to retrieve all types.

curl -X 'GET' \
  '{REPOSITORY_URL}?typeId=animal&includePropertyDefinitions=true&depth=2'

[
  {
    "type": {
      "id": "dog",
      ...
    },
    "children": [
      {
        "type": {
          "id": "largeDog",
          ...
        },
        "children": [
          {
            "type": {
              "id": "germanShepherd",
              ...
            }
          },
          {
            "type": {
              "id": "greatDane",
              ...
            }
          }
        ]
      },
      {
        "type": {
          "id": "smallDog",
          ...
        },
        "children": [
          {
            "type": {
              "id": "chihuahua",
              ...
            }
          },
          {
            "type": {
              "id": "pomeranian",
              ...
            }
          }
        ]
      }
    ]
  },
  {
    "type": {
      "id": "cat",
      ...
    }
  }
]

Update Type

The updateType operation in Contendo Server allows modifying an existing custom type definition. This operation enables changing certain attributes and property definitions while maintaining the type's integrity.

Rules:

• general rules
• type attributes:
  • id serves as the identifier to determine which type should be updated.
  • queryName, baseId and parentId may not be changed.
  • omitting an attribute sets the value to null - even unchanging attributes should be set.
• property definitions:
  • only updated or added property definitions need to be defined. Others will be left unchanged.
  • types with descendant types may be updated, but new properties already present on any descendant type may not be added.
  • property constraints can be broadened but not narrowed. E.g. for a string property definition with max length 25, the max length can be increased (e.g. set to 30), but not decreased (e.g. set to 20).
  • added property definitions with the attribute required set to true must also have the defaultValue attribute set.
  • the attribute required may not change form true to false. The opposite is allowed.
  • propertyType, cardinality and queryName may not change
  • the attribute openChoice may not change form true to false. The opposite is allowed.
  • choices attribute values may not be removed if openChoice is false, but may be added to.
• base types can be updated in a very limited fashion:
  • custom type attributes may be added
  • custom property definition attributes may be added to existing property definitions.

curl -X 'POST' \
  '{REPOSITORY_URL}' \
  -H 'Content-Type: application/json' \
  -d '{
    "operation": "updateType",
    "type": {
      "id": "dog",
      "localName": "dog",
      "displayName": "Dog",
      "description": "A document for dogs.",
      "baseId": "cmis:document",
      "parentId": "animal",
      "show": true,
      "propertyDefinitions": {
        "color": {
          "id": "color",
          "localName": "color",
          "displayName": "Color",
          "description": "Dog color",
          "propertyType": "string",
          "choices": [
            "White",
            "Brown",
            "Black",
            "Gray",
            "Unknown"
          ],
          "openChoice": false,
          "defaultValue": "Unknown",
          "order": 10
        },
        "weight": {
          "id": "weight",
          "localName": "weight",
          "displayName": "Weight",
          "description": "Dog weight",
          "propertyType": "integer",
          "required": true,
          "order": 30
        }
      }
    }
  }'

Delete Type

The deleteType operation in Contendo Server allows for the removal of a custom object type from the repository. A type can only be deleted if it has no existing objects and no descendant types. Base types can't be deleted.

curl -X 'POST' \
  '{REPOSITORY_URL}' \
  -H 'Content-Type: application/json' \
  -d '{
    "operation": "deleteType",
    "typeId": "dog"
  }'

Errors

In case of errors, the response body is a JSON with the message field. Notable errors include: