# Altium 365 API — System Design schema slice (~3519 tokens) # Not a complete schema: types from other contexts are referenced, not defined. # Full schema for code generation: https://altiumdeveloper.github.io/platform-api-docs/schema.graphql # Referenced from other contexts: # DateTime → Common: https://altiumdeveloper.github.io/platform-api-docs/reference/common/schema.graphql # DesPermission → Platform: https://altiumdeveloper.github.io/platform-api-docs/reference/platform/schema.graphql # DesWorkspaceUser → Platform: https://altiumdeveloper.github.io/platform-api-docs/reference/platform/schema.graphql type Query { "Gets ESD Document by identifier." sysEsdDocumentById(id: ID!): SysEsdDocument "Gets all available ESD Documents." sysEsdDocuments: [SysEsdDocument!]! "Gets ESD Document by identifiers." sysEsdDocumentsByIds(ids: [ID!]!): [SysEsdDocument!]! "Builds the System Data Model from the ESD Document and returns it as JSON." sysEsdSystemDataModelByEsdId(id: ID!): String! "Retrieves a software component." sysLibSoftwareComponentById(id: ID!): SysLibSoftwareComponent "Retrieves all available software components." sysLibSoftwareComponents: [SysLibSoftwareComponent]! "Resolves uploaded user libraries to presigned archive download urls." sysLibSoftwareLibraryDownloads(ids: [ID!]!): [SysLibSoftwareLibraryDownload!]! "Retrieves all available schema versions." sysSdmSchemaVersionRegistry: [SysSdmSchemaRegistryEntry!]! "Retrieves a system model." sysSdmSystemModelById(id: ID!): SysSdmSystemModel! "Retrieves a list of system models." sysSdmSystemModelsByIds(ids: [ID!]!): [SysSdmSystemModel]! "Retrieves a system model version." sysSdmSystemModelVersionById(id: ID!): SysSdmSystemModelVersion! } type Mutation { "Creates new ESD Document." sysEsdCreateDocument(input: SysEsdCreateDocumentInput!): SysEsdCreateDocumentPayload! "Deletes ESD Document by identifier." sysEsdDeleteDocument(input: SysEsdDeleteDocumentInput!): SysEsdDeleteDocumentPayload! "Exports new ESD Document." sysEsdExportDocument(input: SysEsdExportDocumentInput!): SysEsdExportDocumentPayload! "Imports new ESD Document." sysEsdImportDocument(input: SysEsdImportDocumentInput!): SysEsdImportDocumentPayload! "Updates the ESD Document." sysEsdUpdateDocument(input: SysEsdUpdateDocumentInput!): SysEsdUpdateDocumentPayload! "Deletes an uploaded user software library." sysLibDeleteSoftwareLibrary(input: SysLibDeleteSoftwareLibraryInput!): SysLibDeleteSoftwareLibraryPayload! "Uploads a user software library archive, or replaces an existing one by its library identifier." sysLibUploadSoftwareLibrary(input: SysLibUploadSoftwareLibraryInput!): SysLibUploadSoftwareLibraryPayload! "Builds the System Data Model from the solution's first ESD document and returns it as JSON. The result is not stored." sysSdmBuildSystemModelFromSolution(input: SysSdmBuildSystemModelFromSolutionInput!): SysSdmBuildSystemModelFromSolutionPayload! "Adds a new system model." sysSdmCreateSystemModelVersion(input: SysSdmCreateSystemModelVersionInput!): SysSdmCreateSystemModelVersionPayload! } type SysEsdCompiledMetadata { connections: [SysEsdConnection!] functionalBlocks: [SysEsdFunctionalBlock!] parameters: [SysEsdParameter!] } type SysEsdConnection { id: String! } "Result of creating a new ESD document." type SysEsdCreateDocumentPayload { "The newly created ESD document." data: SysEsdDocument! } "Result of deleting an ESD document." type SysEsdDeleteDocumentPayload { "Indicates whether the ESD document was deleted successfully." isDeleted: Boolean! } "Represents an ESD (Electronic System Design) document stored in a regional workspace." type SysEsdDocument { "Date and time when the ESD document was created." createdAt: DateTime! "User who created the ESD document." createdBy: DesWorkspaceUser! createdById: ID! @deprecated(reason: "Field plays a technical role for schema stitching purposes.") "Optional description of the ESD document." description: String! "Identifier of the folder that contains the ESD document." folderId: String! "Unique identifier of the ESD document." id: ID! "Gets current scaffolding status." isScaffolding: Boolean! "Gets compiled ESD for the document." model: SysEsdCompiledMetadata "Date and time when the ESD document was last modified, or null if it has never been modified." modifiedAt: DateTime "User who last modified the ESD document, or null if it has never been modified." modifiedBy: DesWorkspaceUser modifiedById: ID @deprecated(reason: "Field plays a technical role for schema stitching purposes.") "Display name of the ESD document." name: String! "Esd document's owner." owner: DesWorkspaceUser "Collection of the Esd document's permissions." permissions: [DesPermission!] "URL of the ESD document preview image." previewUrl: String! } "Result of exporting an ESD document." type SysEsdExportDocumentPayload { "Serialized JSON representation of the exported ESD document." esdDocumentJson: String! } type SysEsdFunctionalBlock { id: String! keyComponents: [SysEsdKeyComponent!] name: String parameters: [SysEsdParameter!] ports: [SysEsdPort!] portsAssociations: [SysEsdPortAssociation!] softwareComponents: [SysEsdSoftwareComponent!] } "Result of importing content into an ESD document." type SysEsdImportDocumentPayload { "Indicates whether the ESD document content was imported successfully." isImported: Boolean! } type SysEsdKeyComponent { childSoftwareComponentsIds: [String!] id: String! name: String parameters: [SysEsdParameter!] } type SysEsdParameter { id: String! name: String value: String! } type SysEsdPort { associationId: String id: String! name: String parameters: [SysEsdParameter!] } type SysEsdPortAssociation { id: String! portId: String! portLibraryName: String! softwareComponentId: String! } type SysEsdSoftwareComponent { id: String! name: String parameters: [SysEsdParameter!] parentKeyComponentId: String! portsAssociationsIds: [String!] } "Result of updating an ESD document." type SysEsdUpdateDocumentPayload { "The updated ESD document." data: SysEsdDocument! } type SysLibDeleteSoftwareLibraryPayload { boolean: Boolean } type SysLibSoftwareComponent { category: String! id: ID! name: String! specifications: [SysLibSoftwareComponentSpecification!]! } type SysLibSoftwareComponentSpecification { ecosystem: String! name: String! vendor: String! } type SysLibSoftwareLibraryDownload { downloadUrl: String fileName: String! id: ID! name: String! } type SysLibUploadSoftwareLibraryPayload { sysLibSoftwareComponent: SysLibSoftwareComponent } type SysSdmAuthoringApplication { applicationId: String! name: String version: String } type SysSdmBuildSystemModelFromSolutionPayload { sysSdmSystemDataModelContent: SysSdmSystemDataModelContent } type SysSdmConnection { endpoints: [SysSdmEndpoint!] id: ID! name: String parameters: [SysSdmParameter!] } type SysSdmCreateSystemModelVersionPayload { sysSdmSystemModelVersion: SysSdmSystemModelVersion } type SysSdmDeviceModel { boardName: String id: ID! mpn: String! peripherals: [SysSdmPeripheral!] ports: [SysSdmDmPort!] } type SysSdmDmPeripheralConfiguration { id: ID! parameters: [SysSdmDmPeripheralParameter!] pinConfigs: [SysSdmDmPeripheralPinConfig!] pinDependencyConfigs: [SysSdmDmPeripheralPinDependencyConfig!] } type SysSdmDmPeripheralInstance { id: ID! interfaceType: String modes: [SysSdmDmPeripheralMode!] name: String unit: String virtualization: SysSdmDmPeripheralVirtualization } type SysSdmDmPeripheralMode { configurations: [SysSdmDmPeripheralConfiguration!] name: String } type SysSdmDmPeripheralParameter { name: String! value: String! } type SysSdmDmPeripheralPinConfig { channel: String function: String pinName: String pinValue: String port: String portName: String } type SysSdmDmPeripheralPinDependencyConfig { name: String value: String } type SysSdmDmPort { configurations: [SysSdmDmPortConfiguration!] connections: [SysSdmDmPortConnection!] description: String functions: [SysSdmDmPortFunction!] id: ID! name: String pin: String symbolicName: String } type SysSdmDmPortConfiguration { enumValues: [SysSdmDmPortConfigurationEnumValue!] id: ID! name: String } type SysSdmDmPortConfigurationDependency { altRef: String configRef: String! functionName: String gpioMode: SysSdmDmGpioMode peripheralInstanceName: String port: String portMode: SysSdmDmPortMode } type SysSdmDmPortConfigurationEnumValue { dependencies: [SysSdmDmPortConfigurationDependency!] id: ID! name: String } type SysSdmDmPortConnection { id: ID! name: String } type SysSdmDmPortFunction { name: String peripheralInstance: String } type SysSdmEndpoint { functionalBlockId: String! portId: String! } type SysSdmFunctionalBlock { hardwareComponentIds: [String!] id: ID! name: String parameters: [SysSdmParameter!] ports: [SysSdmPort!] sdmReferenceDesignator: String! } type SysSdmFunctionalModel { connections: [SysSdmConnection!] functionalBlocks: [SysSdmFunctionalBlock!] id: ID! implementedBy: String name: String } type SysSdmHardwareComponent { deviceModelId: String id: ID! name: String parameters: [SysSdmParameter!] sdmReferenceDesignator: String! } type SysSdmHardwareModel { functionalBlockIds: [String!] hardwareComponents: [SysSdmHardwareComponent!] id: ID! implementedBy: String name: String sdmReferenceDesignator: String! } type SysSdmParameter { id: ID! name: String value: String! } type SysSdmPeripheral { id: ID! instances: [SysSdmDmPeripheralInstance!] name: String } type SysSdmPort { hardwareComponentId: String id: ID! name: String parameters: [SysSdmParameter!] peripheralInstanceId: String portType: String sdmReferenceDesignator: String! softwareComponentId: String } type SysSdmSchemaRegistryEntry { cdmReleaseUrl: String! cdmVersion: String! description: String! isLatest: Boolean! isOnlySemantic: Boolean! isPullDeprecated: Boolean! isPushDeprecated: Boolean! migrationNotes: String! schemaVersion: String! status: String! } type SysSdmSoftwareComponent { id: ID! implementedBy: [String!] libraryComponentId: String name: String parameters: [SysSdmParameter!] sdmReferenceDesignator: String! } type SysSdmSoftwareModel { deviceModelId: String id: ID! implementedBy: String name: String sdmReferenceDesignator: String! softwareComponents: [SysSdmSoftwareComponent!] softwareStackInstances: [SysSdmSoftwareStackInstance!] } type SysSdmSoftwareSpecification { category: SysSdmSoftwareComponentCategory ecosystem: String name: String vendor: String version: String } type SysSdmSoftwareStackInstance { dependencyIds: [String!]! id: ID! name: String parameters: [SysSdmParameter!] peripheralInstanceId: String specification: SysSdmSoftwareSpecification! } type SysSdmSystemDataModelContent { content: String! "Uploads the content as a JSON file to the Files service and returns a pre-signed download URL, valid for one hour." downloadUrl: String! } "**Experimental**" type SysSdmSystemModel @experimental { "**Experimental**" id: ID! latestVersion: SysSdmSystemModelVersion! name: String! versions: [SysSdmSystemModelVersion!] } type SysSdmSystemModelVersion { deviceModels: [SysSdmDeviceModel!] downloadUrl(schemaVersion: String): String! functionalModel: SysSdmFunctionalModel hardwareModels: [SysSdmHardwareModel!] id: ID! metadata: SysSdmSystemModelVersionMetadata name: String schemaVersion: String softwareModels: [SysSdmSoftwareModel!] version: Int! } type SysSdmSystemModelVersionMetadata { authoringApplication: SysSdmAuthoringApplication! createdAt: DateTime! createdBy: String! tags: [String!]! } "Input for creating a new ESD document." input SysEsdCreateDocumentInput { "Optional description of the ESD document to create." description: String "Identifier of the folder in which the ESD document is created." folderId: String! "Display name of the ESD document to create." name: String! "Optional identifier of the flow that initiated the document creation." sourceFlow: String } "Input for deleting an ESD document." input SysEsdDeleteDocumentInput { "Identifier of the ESD document to delete." id: ID! } "Input for exporting an ESD document." input SysEsdExportDocumentInput { "Identifier of the ESD document to export." id: ID! } "Input for importing content into an existing ESD document." input SysEsdImportDocumentInput { "Serialized JSON representation of the ESD document content to import." esdDocumentJson: String! "Identifier of the ESD document to import content into." id: String! } "Input for updating an existing ESD document." input SysEsdUpdateDocumentInput { "New description of the ESD document. When null, the description is left unchanged." description: String "Not used." folderId: String "Identifier of the ESD document to update." id: ID! "New display name of the ESD document. When null, the name is left unchanged." name: String } input SysLibDeleteSoftwareLibraryInput { libraryId: ID! } input SysLibUploadSoftwareLibraryInput { fileId: String! fileName: String! libraryId: ID name: String! } input SysSdmBuildSystemModelFromSolutionInput { solutionId: ID! } input SysSdmCreateSystemModelVersionInput { applicationVersion: String schemaVersion: String systemModelId: ID! systemModelVersionFileId: String! tags: [String!] version: Int! } enum SysSdmDmGpioMode { INPUT NONE OUTPUT_HIGH OUTPUT_LOW } enum SysSdmDmPeripheralVirtualization { CHANNEL NONE } enum SysSdmDmPortMode { ALTERNATE_FUNCTION GPIO } enum SysSdmSoftwareComponentCategory { APPLICATION DRIVER LIBRARY MIDDLEWARE OPERATING_SYSTEM }