Add bundle

post

/api/pvlt/1.0/ctl/bundles

Adds a bundle.

See Create the bundles in the Create a custom data type guide for more information on using this operation.

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

Request

Query parameters

• custom_audit - string

Request body

application/json

required*

All of:

12

Min properties: 1Properties:

• description - string

  Max length: 450
• code - string

  Format: byte

Example

{
  "name": "example_bundle",
  "description": "An example bundle that exports a validator, normalizer, transformer, and action",
  "code": "U2FtcGxlIGNvZGU="
}

Possible responses

200

application/json

required*

All of:

12

Min properties: 1Properties:

• description - string

  Max length: 450
• code - string

  Format: byte

Example

{
  "name": "example_bundle",
  "description": "An example bundle that exports a validator, normalizer, transformer, and action",
  "exports": {
    "validators": [
      {
        "name": "is_positive",
        "type": "validator",
        "description": "A validator that returns true if its argument is positive.",
        "dependencies": {
          "properties": []
        }
      }
    ],
    "normalizers": [
      {
        "name": "to_lower",
        "type": "normalizer",
        "description": "A normalizer that formats a string to lowercase without any dependencies."
      }
    ],
    "transformers": [
      {
        "name": "to_name_with_title",
        "type": "transformer",
        "description": "A transformer that accepts a full name and returns it prepended with a title.",
        "dependencies": {
          "properties": [
            "gender",
            "marital_status"
          ]
        }
      }
    ],
    "actions": [
      {
        "name": "decrypt_and_send",
        "type": "action",
        "description": "An action that decrypts an object and sends it to a compliant third-party service."
      }
    ]
  },
  "code": "U2FtcGxlIGNvZGU=",
  "creation_time": "2022-12-02T02:02:14.398599Z"
}

400

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

401

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

403

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

404

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

405

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

409

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

410

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

500

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

503

application/json

object required*

Additional properties: falseProperties:

• context - object required*

  Values of additional properties are strings

  Example

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

  Example: "PVxxxx"
• message - string required*

  Example: "The object is not found."
• error_url - string

  Example: "https://docs.piiano.com/api/error-codes#PV1005"

Example

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

Try the API

Authorization

API key:

Query parameters

Custom_audit:

Request body

Content-Type:

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

Code examples

Example