{
 "openapi": "3.1.0",
 "info": {
  "title": "Custom Objects (Platform)",
  "version": "20261030b",
  "description": "Tables this company defines for itself: name the object, add its fields, and it gets a screen, search, import, audit and its own grants (Custom Objects tab). Nothing here changes a standard screen. Limits: 50 objects, 80 fields and a million records each. Switch an object off to hide it and keep its records; delete it only on purpose."
 },
 "servers": [
  {
   "url": "https://{tenant}.tranxact.ai",
   "variables": {
    "tenant": {
     "default": "demo"
    }
   }
  }
 ],
 "components": {
  "securitySchemes": {
   "bearer": {
    "type": "http",
    "scheme": "bearer"
   }
  },
  "schemas": {
   "custom-objects": {
    "type": "object",
    "required": [],
    "properties": {
     "id": {
      "type": "string",
      "format": "uuid",
      "description": "Id",
      "readOnly": true
     },
     "org_id": {
      "type": "string",
      "format": "uuid",
      "description": "Org id",
      "readOnly": true
     },
     "object_key": {
      "type": "string",
      "description": "Key",
      "readOnly": true
     },
     "label": {
      "type": "string",
      "description": "Name (singular)",
      "readOnly": true
     },
     "plural_label": {
      "type": "string",
      "description": "Name (plural)",
      "readOnly": true
     },
     "description": {
      "type": "string",
      "description": "What it is for",
      "readOnly": true
     },
     "prefix": {
      "type": "string",
      "description": "Number prefix",
      "readOnly": true
     },
     "next_no": {
      "type": "string",
      "format": "decimal",
      "description": "Next no",
      "readOnly": true
     },
     "title_field": {
      "type": "string",
      "description": "Title field (a field key)",
      "readOnly": true
     },
     "has_status": {
      "type": "boolean",
      "description": "Records have a status",
      "readOnly": true
     },
     "status_options": {
      "type": "object",
      "description": "Statuses",
      "readOnly": true
     },
     "table_name": {
      "type": "string",
      "description": "Table name",
      "readOnly": true
     },
     "record_count": {
      "type": "string",
      "format": "decimal",
      "description": "Record count",
      "readOnly": true
     },
     "max_records": {
      "type": "integer",
      "description": "Max records",
      "readOnly": true
     },
     "is_active": {
      "type": "boolean",
      "description": "On",
      "readOnly": true
     },
     "created_by": {
      "type": "string",
      "format": "uuid",
      "description": "Created by",
      "readOnly": true
     },
     "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Created at",
      "readOnly": true
     },
     "updated_by": {
      "type": "string",
      "format": "uuid",
      "description": "Updated by",
      "readOnly": true
     },
     "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "Updated at",
      "readOnly": true
     },
     "xf_text_1": {
      "type": "string",
      "description": "Xf text 1",
      "readOnly": true
     },
     "xf_text_2": {
      "type": "string",
      "description": "Xf text 2",
      "readOnly": true
     },
     "xf_text_3": {
      "type": "string",
      "description": "Xf text 3",
      "readOnly": true
     },
     "xf_text_4": {
      "type": "string",
      "description": "Xf text 4",
      "readOnly": true
     },
     "xf_text_5": {
      "type": "string",
      "description": "Xf text 5",
      "readOnly": true
     },
     "xf_num_1": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 1",
      "readOnly": true
     },
     "xf_num_2": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 2",
      "readOnly": true
     },
     "xf_num_3": {
      "type": "string",
      "format": "decimal",
      "description": "Xf num 3",
      "readOnly": true
     },
     "xf_date_1": {
      "type": "string",
      "format": "date",
      "description": "Xf date 1",
      "readOnly": true
     },
     "xf_date_2": {
      "type": "string",
      "format": "date",
      "description": "Xf date 2",
      "readOnly": true
     }
    }
   }
  }
 },
 "security": [
  {
   "bearer": []
  }
 ],
 "paths": {
  "/api/platform/custom-objects": {
   "get": {
    "summary": "list custom-objects",
    "operationId": "list_custom_objects_0_4",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "post": {
    "summary": "Post custom objects",
    "operationId": "action_custom_objects_1_4",
    "description": "Body keys: grants",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/custom-objects/{id}": {
   "get": {
    "summary": "get custom-objects",
    "operationId": "get_custom_objects_0_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "put": {
    "summary": "Put custom objects",
    "operationId": "action_custom_objects_1_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   },
   "delete": {
    "summary": "Delete custom objects",
    "operationId": "action_custom_objects_2_5",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/custom-objects/import": {
   "post": {
    "summary": "Import",
    "operationId": "action_custom_objects_0_5",
    "description": "Body keys: design",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/custom-objects/{id}/export": {
   "get": {
    "summary": "Export",
    "operationId": "action_custom_objects_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/custom-objects/{id}/grant": {
   "post": {
    "summary": "Grant",
    "operationId": "action_custom_objects_0_6",
    "description": "Body keys: role*, add, change, display, delete",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/custom-objects/choices/objects": {
   "get": {
    "summary": "Choices objects",
    "operationId": "action_custom_objects_0_6",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  },
  "/api/platform/custom-objects/{id}/copy": {
   "post": {
    "summary": "Copy",
    "operationId": "action_custom_objects_0_6",
    "description": "Body keys: overrides, preview, withLines",
    "responses": {
     "200": {
      "description": "OK"
     },
     "401": {
      "description": "No or bad credential"
     },
     "403": {
      "description": "Not granted"
     },
     "422": {
      "description": "Refused by validation"
     }
    }
   }
  }
 }
}