{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/autodesk-construction-cloud/json-schema/autodesk-construction-cloud-form-payload-schema.json",
  "title": "FormPayload",
  "description": "The details of the form to create.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/autodesk-construction-cloud-forms-openapi.yml#/components/schemas/FormPayload",
  "type": "object",
  "properties": {
    "assigneeId": {
      "type": "string",
      "description": "Identifier of the company, role, or user assigned to the form. Note: the assignee must be a contributor of the template."
    },
    "assigneeType": {
      "$ref": "#/$defs/AssigneeType"
    },
    "description": {
      "type": "string",
      "description": "Text for the form description field. Max length: 8000."
    },
    "name": {
      "type": "string",
      "description": "The name of the form instance. If the specified value is null or empty, it defaults to the form's template name. Max length: 100."
    },
    "formDate": {
      "type": "string",
      "description": "Date the form pertains to, must be after 1950-01-01."
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the form. If you do not specify an ID, one will be assigned."
    },
    "locationId": {
      "type": "string",
      "format": "uuid",
      "description": "Location associated with the Form. For more information about the location, see GET nodes."
    },
    "notes": {
      "type": "string",
      "description": "Text for the form's notes section. Max length: 8000."
    },
    "userCreatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the form was created on the client device or external system (optional). Use this to preserve the original creation time when syncing forms that were created offline."
    }
  },
  "$defs": {
    "AssigneeType": {
      "type": "string",
      "description": "Type of entity the form is assigned to. Possible values: company, role, user",
      "enum": [
        "company",
        "role",
        "user"
      ]
    }
  }
}