1Factory · JSON Structure

1Factory Plan Detail Structure

PlanDetail schema from 1Factory API

Type: object Properties: 19

AnalyticsData CollectionManufacturingMonitoringQuality

PlanDetail is a JSON Structure definition published by 1Factory, describing 19 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ID part_number rev part_description operation project_identifier status version version_status approval_status customer_name supplier_name supplier_number is_tabulated is_spec_lib created_by_name created_on updated_on specifications

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/1factory/refs/heads/main/json-structure/1factory-plan-detail-structure.json",
  "name": "PlanDetail",
  "description": "PlanDetail schema from 1Factory API",
  "type": "object",
  "properties": {
    "ID": {
      "$ref": "#/components/schemas/ID"
    },
    "part_number": {
      "$ref": "#/components/schemas/part_number"
    },
    "rev": {
      "$ref": "#/components/schemas/rev"
    },
    "part_description": {
      "$ref": "#/components/schemas/part_description"
    },
    "operation": {
      "$ref": "#/components/schemas/operation"
    },
    "project_identifier": {
      "$ref": "#/components/schemas/project_identifier"
    },
    "status": {
      "$ref": "#/components/schemas/status"
    },
    "version": {
      "type": "double",
      "description": "Version of the plan.",
      "example": 4
    },
    "version_status": {
      "type": "string",
      "enum": [
        "Active",
        "Draft",
        "Approval",
        "Released",
        "Inactive"
      ]
    },
    "approval_status": {
      "type": "string",
      "enum": [
        "N/a",
        "Pending",
        "Assigned",
        "Approved",
        "Rejected"
      ],
      "description": "The status of a plan that requires approval before releasing or closing.\n\n(Availability depends on Organization settings.)"
    },
    "customer_name": {
      "$ref": "#/components/schemas/customer_name"
    },
    "supplier_name": {
      "$ref": "#/components/schemas/supplier_name"
    },
    "supplier_number": {
      "$ref": "#/components/schemas/supplier_number"
    },
    "is_tabulated": {
      "type": "boolean",
      "example": false,
      "description": "If the plan is for a tabulated part."
    },
    "is_spec_lib": {
      "type": "boolean",
      "example": false,
      "description": "If the plan is a spec library"
    },
    "created_by_name": {
      "$ref": "#/components/schemas/created_by_username"
    },
    "created_on": {
      "$ref": "#/components/schemas/created_on"
    },
    "updated_on": {
      "$ref": "#/components/schemas/updated_on"
    },
    "specifications": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "$ref": "#/components/schemas/Specification"
          },
          {
            "type": "object",
            "properties": {
              "inspection_types": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/SpecInspectionType"
                }
              }
            }
          }
        ]
      }
    }
  }
}