Valstorm LogoDev

object Endpoints

All endpoints for the object API group. Great for feeding into an LLM context.

POST

/v1/object/export

Export Records Api
Request Body
{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ExportRecordsRequest"
      }
    }
  },
  "required": true
}
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/object/{api_name}/import

Import Records Csv
Parameters
api_name*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "multipart/form-data": {
      "schema": {
        "$ref": "#/components/schemas/Body_import_records_csv_v1_object__api_name__import_post"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/object/{api_name}/import/vcard

Import Records Vcard
Parameters
api_name*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "multipart/form-data": {
      "schema": {
        "$ref": "#/components/schemas/Body_import_records_vcard_v1_object__api_name__import_vcard_post"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
POST

/v1/object/{api_name}

Create Records Api
Parameters
api_name*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "anyOf": [
          {
            "type": "object",
            "additionalProperties": true
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          }
        ],
        "title": "Data"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
PATCH

/v1/object/{api_name}

Update Records Api
Parameters
api_name*
in: path
type: string
Request Body
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "anyOf": [
          {
            "type": "object",
            "additionalProperties": true
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          }
        ],
        "title": "Data"
      }
    }
  }
}
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
DELETE

/v1/object/{api_name}

Delete Records Api
Parameters
api_name*
in: path
type: string
ids*
in: query
type: any
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner
DELETE

/v1/object/{api_name}/{record_id}

Delete Record Api
Parameters
api_name*
in: path
type: string
record_id*
in: path
type: string
Responses
200
Successful Response
application/json
{}
404
Not found
422
Validation Error
application/json
{
  "$ref": "#/components/schemas/HTTPValidationError"
}
API Runner