Skip to main content

Build Push JSON Schema

Yordan Mitrev avatar
Written by Yordan Mitrev
Updated over 2 months ago
{
"type": "object",
"description": "Build push message schema",
"required": [
"id",
"version",
"type",
"eventTime",
"data"
],
"properties": {
"id": {
"type": "string",
"description": "Unique message id"
},
"version": {
"type": "string",
"description": "Message schema version"
},
"type": {
"type": "string",
"description": "Message type"
},
"eventTime": {
"type": "string",
"description": "Date and time of message creation e.g. 2020-02-21 12:00:00"
},
"data": {
"type": "object",
"description": "Content of the message",
"required": [
"build_id",
"build_notes",
"build_pdf",
"sliced_build_url",
"nested_build_url",
"build_duration",
"build_status",
"machine_name",
"machine_group_custom_id",
"batch"
],
"properties": {
"build_id": {
"type": "string",
"description": "Build id"
},
"build_notes": {
"type": "string",
"description": "Build comment"
},
"build_pdf": {
"type": "string",
"description": "Path to pdf document in storage that describe build"
},
"sliced_build_url": {
"type": "array",
"description": "List of build sliced files",
"items": {
"type": "string",
"description": "Path in storage to build slice file"
}
},
"nested_build_url": {
"type": "string",
"description": "Path in storage to build nested file"
},
"build_duration": {
"type": "integer",
"description": "Duration of the build in seconds"
},
"build_status": {
"type": "string",
"description": "Build status"
},
"machine_name": {
"type": "string",
"description": "Machine associated to the build"
},
"machine_group_custom_id": {
"type": "string",
"description": "Id of the machine associated to the build"
},
"batch": {
"type": "array",
"description": "List of batches",
"items": {
"type": "object",
"description": "List of batch items",
"required": [
"part_id",
"batch_id",
"order_id",
"material",
"additional_files",
"batch_pdf",
"thumbnail",
"production_notes",
"post_processing_services",
"items"
],
"properties": {
"part_id": {
"type": "string",
"description": "Order part id"
},
"batch_id": {
"type": "string",
"description": "Batch id"
},
"order_id": {
"type": "string",
"description": "Order id"
},
"material": {
"type": "string",
"description": "Name of the material that will be used for build"
},
"additional_files": {
"type": "array",
"description": "List of instructions that attached to the build",
"items": {
"type": "string",
"description": "Path to build additional file in storage"
}
},
"batch_pdf": {
"type": "string",
"description": "Path to pdf document in storage that describe build batch"
},
"thumbnail": {
"type": "string",
"description": "Path to 2d image of printed part in storage"
},
"production_notes": {
"type": "array",
"description": "List of production notes",
"items": {
"type": "string",
"description": "Production note for order part"
}
},
"custom_quotation_fields": {
"type": "array",
"description": "List of quotation custom fields",
"items": {
"type": "object",
"description": "Custom quotation field data",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Quotation field name"
},
"value": {
"type": "string",
"description": "Quotation field value"
}
}
}
},
"post_processing_services": {
"type": "array",
"description": "List of post processing services",
"items": {
"type": "object",
"description": "Post processing service",
"required": [
"name",
"properties"
],
"properties": {
"name": {
"type": "string",
"description": "Name of post processing service"
},
"pps_custom_id": {
"type": "string",
"description": "Custom id for post processing service"
},
"properties": {
"type": "array",
"description": "List of post processing service properties",
"items": {
"type": "object",
"description": "Post processing service property",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string",
"description": "Name of post processing service property"
},
"value": {
"type": "string",
"description": "Value of post processing service property"
}
}
}
},
"additional_files": {
"type": "array",
"description": "List of post processing service additional files",
"items": {
"type": "string",
"description": "Path to processing service additional file in storage"
}
}
}
}
},
"items": {
"type": "array",
"description": "List of part items",
"items": {
"type": "object",
"description": "Detailed description of part item",
"required": [
"part_item_id",
"shipping_deadline",
"status",
"item_pdf"
],
"properties": {
"part_item_id": {
"type": "string",
"description": "Combination of order part id and item id"
},
"shipping_deadline": {
"type": "string",
"description": "Item shipping deadline date e.g. 2020-02-20"
},
"status": {
"type": "string",
"description": "Item status"
},
"item_pdf": {
"type": "string",
"description": "Path to pdf file with item barcode"
}
}
}
}
}
}
}
}
}
}
}

Did this answer your question?