Document data model

Updated:

One revision of an engineering document

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
master_identifierstringNoVendor ID shared by every revision of the same document; not a unified object
numberstringNo
namestringNo
descriptionstringNo
revisionstringNo
statusenumNoNormalized lifecycle status of a part or document revision Values: IN_WORK, IN_REVIEW, RELEASED, OBSOLETE, OTHER
lifecycle_statestringNo
typeenumNoNormalized document type Values: DRAWING, CAD_MODEL, SPECIFICATION, PROCEDURE, REPORT, OTHER
original_typestringNoThe vendor's own document type name
category_idstringNoThe PlmCategory the document is filed under (reference to AccountingCategory)
part_idsstring[]NoRelated PlmPart IDs
file_idsstring[]NoAttachment IDs retrievable from StorageFile
user_idstringNo(reference to HrisEmployee)
urlstringNo
metadataPlmMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type PlmDocument = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	master_identifier?: string; // Vendor ID shared by every revision of the same document; not a unified object
	number?: string;
	name?: string;
	description?: string;
	revision?: string;
	status?: 'IN_WORK' | 'IN_REVIEW' | 'RELEASED' | 'OBSOLETE' | 'OTHER'; // Normalized lifecycle status of a part or document revision
	lifecycle_state?: string;
	type?: 'DRAWING' | 'CAD_MODEL' | 'SPECIFICATION' | 'PROCEDURE' | 'REPORT' | 'OTHER'; // Normalized document type
	original_type?: string; // The vendor's own document type name
	category_id?: string; // The PlmCategory the document is filed under (reference to AccountingCategory)
	part_ids?: string[]; // Related PlmPart IDs
	file_ids?: string[]; // Attachment IDs retrievable from StorageFile
	user_id?: string; // (reference to HrisEmployee)
	url?: string;
	metadata?: [];
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodPlmDocument = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	master_identifier: z.string().optional().describe("Vendor ID shared by every revision of the same document; not a unified object"),
	number: z.string().optional(),
	name: z.string().optional(),
	description: z.string().optional(),
	revision: z.string().optional(),
	status: z.enum("IN_WORK", "IN_REVIEW", "RELEASED", "OBSOLETE", "OTHER").optional().describe("Normalized lifecycle status of a part or document revision"),
	lifecycle_state: z.string().optional(),
	type: z.enum("DRAWING", "CAD_MODEL", "SPECIFICATION", "PROCEDURE", "REPORT", "OTHER").optional().describe("Normalized document type"),
	original_type: z.string().optional().describe("The vendor's own document type name"),
	category_id: z.string().optional().describe("The PlmCategory the document is filed under (reference to AccountingCategory)"),
	part_ids: z.array().optional().describe("Related PlmPart IDs"),
	file_ids: z.array().optional().describe("Attachment IDs retrievable from StorageFile"),
	user_id: z.string().optional().describe("(reference to HrisEmployee)"),
	url: z.string().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PlmDocumentStatus(str, Enum):
	IN_WORK = 'IN_WORK'
	IN_REVIEW = 'IN_REVIEW'
	RELEASED = 'RELEASED'
	OBSOLETE = 'OBSOLETE'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PlmDocumentType(str, Enum):
	DRAWING = 'DRAWING'
	CAD_MODEL = 'CAD_MODEL'
	SPECIFICATION = 'SPECIFICATION'
	PROCEDURE = 'PROCEDURE'
	REPORT = 'REPORT'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PlmDocument:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Vendor ID shared by every revision of the same document; not a unified object"""
	master_identifier: Optional[str]
	number: Optional[str]
	name: Optional[str]
	description: Optional[str]
	revision: Optional[str]
	"""Normalized lifecycle status of a part or document revision"""
	status: Optional[PlmDocumentStatus]
	lifecycle_state: Optional[str]
	"""Normalized document type"""
	type: Optional[PlmDocumentType]
	"""The vendor's own document type name"""
	original_type: Optional[str]
	"""The PlmCategory the document is filed under (reference to AccountingCategory)"""
	category_id: Optional[str]
	"""Related PlmPart IDs"""
	part_ids: Optional[List[List[str]]]
	"""Attachment IDs retrievable from StorageFile"""
	file_ids: Optional[List[List[str]]]
	"""(reference to HrisEmployee)"""
	user_id: Optional[str]
	url: Optional[str]
	metadata: Optional[PropertyPlmDocumentMetadata]
Are we missing anything? Let us know
Was this page helpful?