Add data type

post

/api/pvlt/1.0/ctl/types

Adds a data type.

The role performing this operation must have the CapTypesWriter capability. See Access control for more information about how capabilities are used to control access to operations.

Request

Request body

Details of the data type, including the names and locations of the JavaScript functions it uses.

application/json

object required*

The data type and its function. default_transformer is the default transformer for the data type and should be taken from the transformers list.

Additional properties: falseProperties:

• name - string required*

  The name of a data type.

  Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 450Example: "STRING"
• is_builtin - boolean

  Whether this data type is built-in or user defined.

• base_type_name - string required*

  The name of a data type.

  Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 450Example: "STRING"
• description - string

  The description of a model.

  Max length: 450
• validator - string

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"
• normalizer - string

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"
• transformers - array of strings

  The names of transformers that are supported for the data type.

  Each string:

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"
• default_transformer - string

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"

Example

{
  "name": "student_id",
  "base_type_name": "STRING",
  "description": "A custom data type representing a student ID based on the built-in STRING type.",
  "validator": "example_bundle.validate_student_id",
  "normalizer": "example_bundle.normalize_student_id",
  "transformers": [
    "example_bundle.format_student_id",
    "example_bundle.mask_first_4_digits"
  ],
  "default_transformer": "example_bundle.format_student_id"
}

Possible responses

200

The request is successful.

application/json

object required*

The data type and its function. default_transformer is the default transformer for the data type and should be taken from the transformers list.

Additional properties: falseProperties:

• name - string required*

  The name of a data type.

  Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 450Example: "STRING"
• is_builtin - boolean

  Whether this data type is built-in or user defined.

• base_type_name - string required*

  The name of a data type.

  Match pattern: ^[a-zA-Z][a-zA-Z0-9_]*$Max length: 450Example: "STRING"
• description - string

  The description of a model.

  Max length: 450
• validator - string

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"
• normalizer - string

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"
• transformers - array of strings

  The names of transformers that are supported for the data type.

  Each string:

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"
• default_transformer - string

  The bundle and function name formatted as <bundle-name>.<function-name>.

  Example: "bundle1.function1"
• creation_time - string

  The time when the data type was created.

  Format: date-timeExample: "2022-07-05T08:47:12.047Z"

Example

{
  "name": "student_id",
  "base_type_name": "STRING",
  "description": "A custom data type representing a student ID based on the built-in STRING type.",
  "validator": "example_bundle.validate_student_id",
  "normalizer": "example_bundle.normalize_student_id",
  "transformers": [
    "example_bundle.format_student_id",
    "example_bundle.mask_first_4_digits"
  ],
  "default_transformer": "example_bundle.format_student_id",
  "creation_time": "2022-12-01T10:04:42.777225Z"
}

400

The request is invalid.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1001",
  "message": "The access reason is missing.",
  "context": {
    "reason": null
  }
}

401

Authentication credentials are incorrect or missing.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1005",
  "message": "The request is unauthorized.",
  "context": {}
}

403

The caller doesn't have the required access rights.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1007",
  "message": "The operation is forbidden due to missing capabilities.",
  "context": {
    "username": "WebServer"
  }
}

404

Reserved for future use.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1004",
  "message": "The data type is not found.",
  "context": {}
}

405

The operation is not allowed.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1026",
  "message": "The operation is not allowed in in-memory mode.",
  "context": {}
}

409

A conflict occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV3218",
  "message": "Concurrent conflicting updates to the same object.",
  "context": {}
}

410

Access to a resource that is no longer available occurs.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1033",
  "message": "The resource is gone.",
  "context": {}
}

500

An error occurs on the server.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1000",
  "message": "Something went wrong",
  "context": {}
}

503

The service is unavailable.

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  The error context.

  Values of additional properties are strings

  Example

  {
    "objectid": "b56dd6aa-35f0-11ed-a261-0242ac120002"
  }
• error_code - string required*

  The error code.

  Example: "PVxxxx"
• message - string required*

  The error message.

  Example: "The object is not found."

Example

{
  "error_code": "PV1009",
  "message": "The operation timed out on the server.",
  "context": {}
}

Try the API

Authorization

API key:

Request body

Content-Type:

Navigate to the docs of your local Vault installation to try the API directly from there.

Code examples

Example