{ "components" : { "schemas" : { "AddNewClassRequest" : { "properties" : { "classLayoutPosition" : { "$ref" : "#/components/schemas/ClassLayoutPositionDTO" }, "className" : { "type" : "string" }, "classURIPrefix" : { "type" : "string" }, "packageDTO" : { "$ref" : "#/components/schemas/PackageDTO" } }, "type" : "object" }, "AffectedResource" : { "properties" : { "actions" : { "items" : { "enum" : [ "DELETE", "KEEP", "REMOVE_PACKAGE_REFERENCE", "REMOVE_SUBCLASS_REFERENCE" ], "type" : "string" }, "type" : "array" }, "children" : { "items" : { "$ref" : "#/components/schemas/AffectedResource" }, "type" : "array" }, "context" : { "additionalProperties" : { "type" : "string" }, "type" : "object" }, "reason" : { "enum" : [ "CONTAINED_IN_PACKAGE", "USES_DELETED_CLASS_AS_DATATYPE", "REFENCES_DELETED_CLASS_VIA_ASSOCIATION", "CHILD_OF", "USES_DELETED_CLASS_AS_DEFAULT_VALUE", "USES_DELETED_CLASS_AS_FIXED_VALUE", "DELETION_REQUESTED_BY_USER" ], "type" : "string" }, "resourceIdentifier" : { "$ref" : "#/components/schemas/ResourceIdentifier" }, "type" : { "enum" : [ "PACKAGE", "CLASS", "ATTRIBUTE", "ASSOCIATION", "ENUM_ENTRY", "ONTOLOGY", "UNKNOWN" ], "type" : "string" } }, "type" : "object" }, "AssociationDTO" : { "properties" : { "associationUsed" : { "type" : "boolean" }, "comment" : { "type" : "string" }, "domain" : { "type" : "string" }, "label" : { "type" : "string" }, "multiplicity" : { "type" : "string" }, "prefix" : { "type" : "string" }, "range" : { "$ref" : "#/components/schemas/DataTypeDTO" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "AssociationPairDTO" : { "properties" : { "from" : { "$ref" : "#/components/schemas/AssociationDTO" }, "to" : { "$ref" : "#/components/schemas/AssociationDTO" } }, "type" : "object" }, "AssociationUUIDs" : { "properties" : { "fromUUID" : { "format" : "uuid", "type" : "string" }, "toUUID" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "AttributeDTO" : { "properties" : { "comment" : { "type" : "string" }, "dataType" : { "$ref" : "#/components/schemas/DataTypeDTO" }, "defaultValue" : { "type" : "string" }, "domain" : { "type" : "string" }, "fixedValue" : { "type" : "string" }, "label" : { "type" : "string" }, "multiplicity" : { "type" : "string" }, "prefix" : { "type" : "string" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "BelongsToCategoryDTO" : { "properties" : { "label" : { "type" : "string" }, "prefix" : { "type" : "string" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "CIMAttribute" : { "properties" : { "comment" : { "$ref" : "#/components/schemas/RDFSComment" }, "dataType" : { "$ref" : "#/components/schemas/CIMSDataType" }, "defaultValue" : { "$ref" : "#/components/schemas/CIMSIsDefault" }, "domain" : { "$ref" : "#/components/schemas/RDFSDomain" }, "fixedValue" : { "$ref" : "#/components/schemas/CIMSIsFixed" }, "label" : { "$ref" : "#/components/schemas/RDFSLabel" }, "multiplicity" : { "$ref" : "#/components/schemas/CIMSMultiplicity" }, "stereotype" : { "type" : "string" }, "uri" : { "$ref" : "#/components/schemas/URI" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "CIMClass" : { "properties" : { "comment" : { "$ref" : "#/components/schemas/RDFSComment" }, "graphUri" : { "type" : "string" }, "label" : { "$ref" : "#/components/schemas/RDFSLabel" }, "package" : { "$ref" : "#/components/schemas/CIMSBelongsToCategory" }, "stereotypes" : { "items" : { "type" : "string" }, "type" : "array" }, "superClass" : { "$ref" : "#/components/schemas/RDFSSubClassOf" }, "uri" : { "$ref" : "#/components/schemas/URI" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "CIMPrefixPair" : { "properties" : { "prefix" : { "type" : "string" }, "substitutedPrefix" : { "type" : "string" } }, "type" : "object" }, "CIMSBelongsToCategory" : { "properties" : { "label" : { "$ref" : "#/components/schemas/RDFSLabel" }, "uri" : { "$ref" : "#/components/schemas/URI" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "CIMSDataType" : { "properties" : { "label" : { "$ref" : "#/components/schemas/RDFSLabel" }, "type" : { "enum" : [ "PRIMITIVE", "RANGE", "UNKNOWN" ], "type" : "string" }, "uri" : { "$ref" : "#/components/schemas/URI" } }, "type" : "object" }, "CIMSIsDefault" : { "properties" : { "blankNode" : { "type" : "boolean" }, "dataType" : { "$ref" : "#/components/schemas/URI" }, "value" : { "type" : "string" } }, "type" : "object" }, "CIMSIsFixed" : { "properties" : { "blankNode" : { "type" : "boolean" }, "dataType" : { "$ref" : "#/components/schemas/URI" }, "value" : { "type" : "string" } }, "type" : "object" }, "CIMSMultiplicity" : { "properties" : { "uri" : { "$ref" : "#/components/schemas/URI" } }, "type" : "object" }, "ChangeLog" : { "properties" : { "redoHistory" : { "items" : { "$ref" : "#/components/schemas/ChangeLogEntry" }, "type" : "array" }, "undoHistory" : { "items" : { "$ref" : "#/components/schemas/ChangeLogEntry" }, "type" : "array" } }, "type" : "object" }, "ChangeLogEntry" : { "properties" : { "changeId" : { "format" : "uuid", "type" : "string" }, "contextDeltas" : { "items" : { "$ref" : "#/components/schemas/ContextDelta" }, "type" : "array" }, "message" : { "type" : "string" }, "steps" : { "format" : "int32", "type" : "integer" }, "timestamp" : { "format" : "date-time", "type" : "string" } }, "type" : "object" }, "ClassDTO" : { "properties" : { "belongsToCategory" : { "format" : "uuid", "type" : "string" }, "comment" : { "type" : "string" }, "graphUri" : { "type" : "string" }, "label" : { "type" : "string" }, "prefix" : { "type" : "string" }, "stereotypes" : { "items" : { "type" : "string" }, "type" : "array" }, "superClass" : { "$ref" : "#/components/schemas/SuperClassDTO" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "ClassInDiagram" : { "properties" : { "graphUri" : { "$ref" : "#/components/schemas/URI" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "ClassLayoutPositionDTO" : { "properties" : { "xposition" : { "format" : "float", "type" : "number" }, "yposition" : { "format" : "float", "type" : "number" } }, "type" : "object" }, "ClassPositionDTO" : { "properties" : { "classUUID" : { "format" : "uuid", "type" : "string" }, "xPosition" : { "format" : "float", "type" : "number" }, "xposition" : { "format" : "float", "type" : "number" }, "yPosition" : { "format" : "float", "type" : "number" }, "yposition" : { "format" : "float", "type" : "number" }, "zPosition" : { "format" : "int32", "type" : "integer" }, "zposition" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ClassRelationsDTO" : { "properties" : { "classesReferencingThisClass" : { "additionalProperties" : { "items" : { "$ref" : "#/components/schemas/ClassDTO" }, "type" : "array" }, "type" : "object" }, "classesReferencingThisClassFromCIM" : { "additionalProperties" : { "items" : { "$ref" : "#/components/schemas/CIMClass" }, "type" : "array" }, "type" : "object", "writeOnly" : true }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "ClassSourceDTO" : { "properties" : { "classUUID" : { "format" : "uuid", "type" : "string" }, "graph" : { "$ref" : "#/components/schemas/GraphDTO" } }, "type" : "object" }, "ClassUMLAdaptedDTO" : { "properties" : { "associationPairs" : { "items" : { "$ref" : "#/components/schemas/AssociationPairDTO" }, "type" : "array" }, "attributes" : { "items" : { "$ref" : "#/components/schemas/AttributeDTO" }, "type" : "array" }, "comment" : { "type" : "string" }, "enumEntries" : { "items" : { "$ref" : "#/components/schemas/EnumEntryDTO" }, "type" : "array" }, "external" : { "type" : "boolean" }, "label" : { "type" : "string" }, "package" : { "$ref" : "#/components/schemas/BelongsToCategoryDTO" }, "prefix" : { "type" : "string" }, "stereotypes" : { "items" : { "type" : "string" }, "type" : "array" }, "superClass" : { "$ref" : "#/components/schemas/ClassUMLAdaptedDTO" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "ContextDelta" : { "properties" : { "additions" : { "properties" : { "enqueued" : { "deprecated" : true, "type" : "boolean" } }, "type" : "object" }, "contextName" : { "type" : "string" }, "deletions" : { "properties" : { "enqueued" : { "deprecated" : true, "type" : "boolean" } }, "type" : "object" } }, "type" : "object" }, "CopyClassResponseDTO" : { "properties" : { "name" : { "type" : "string" }, "uuid" : { "type" : "string" } }, "type" : "object" }, "CrossProfileDiagramColorDataDTO" : { "properties" : { "graphColors" : { "additionalProperties" : { "type" : "string" }, "type" : "object" } }, "type" : "object" }, "CrossProfileDiagramDTO" : { "properties" : { "classes" : { "items" : { "$ref" : "#/components/schemas/MergedClassDTO" }, "type" : "array" }, "diagramId" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "CustomAndGeneratedTupleListPropertyShape" : { "properties" : { "custom" : { "items" : { "$ref" : "#/components/schemas/PropertyShape" }, "type" : "array" }, "generated" : { "items" : { "$ref" : "#/components/schemas/PropertyShape" }, "type" : "array" } }, "type" : "object" }, "CustomAndGeneratedTupleSHACLToClassRelations" : { "properties" : { "custom" : { "$ref" : "#/components/schemas/SHACLToClassRelations" }, "generated" : { "$ref" : "#/components/schemas/SHACLToClassRelations" } }, "type" : "object" }, "CustomDiagramDTO" : { "properties" : { "classes" : { "items" : { "$ref" : "#/components/schemas/ClassInDiagram" }, "type" : "array" }, "diagramId" : { "format" : "uuid", "type" : "string" }, "name" : { "type" : "string" } }, "type" : "object" }, "DataTypeDTO" : { "properties" : { "label" : { "type" : "string" }, "prefix" : { "type" : "string" }, "type" : { "enum" : [ "PRIMITIVE", "RANGE", "UNKNOWN" ], "type" : "string" } }, "type" : "object" }, "DatasetDTO" : { "properties" : { "name" : { "type" : "string" }, "prefixes" : { "items" : { "$ref" : "#/components/schemas/CIMPrefixPair" }, "type" : "array" }, "readOnly" : { "type" : "boolean" } }, "type" : "object" }, "DefaultValueView" : { "properties" : { "associations" : { "items" : { "$ref" : "#/components/schemas/SemanticAssociationChange" }, "type" : "array" }, "attributes" : { "items" : { "$ref" : "#/components/schemas/SemanticAttributeChange" }, "type" : "array" }, "classLabel" : { "type" : "string" }, "enumEntries" : { "items" : { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, "type" : "array" } }, "type" : "object" }, "EnumEntryDTO" : { "properties" : { "comment" : { "type" : "string" }, "label" : { "type" : "string" }, "prefix" : { "type" : "string" }, "stereotype" : { "type" : "string" }, "type" : { "type" : "string" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "GraphBulkImportResponse" : { "properties" : { "failedImports" : { "items" : { "type" : "string" }, "type" : "array" }, "importedGraphUris" : { "items" : { "type" : "string" }, "type" : "array" }, "message" : { "type" : "string" }, "warnings" : { "items" : { "$ref" : "#/components/schemas/ImportWarning" }, "type" : "array" } }, "type" : "object" }, "GraphDTO" : { "properties" : { "keyword" : { "type" : "string" }, "uri" : { "$ref" : "#/components/schemas/URI" } }, "type" : "object" }, "GraphFilter" : { "properties" : { "allowedUUIDs" : { "items" : { "type" : "string" }, "type" : "array" }, "includeAssociations" : { "type" : "boolean" }, "includeAttributes" : { "type" : "boolean" }, "includeEnumEntries" : { "type" : "boolean" }, "includeInheritance" : { "type" : "boolean" }, "includePropertiesFromOtherProfiles" : { "type" : "boolean" }, "includeRelationsToExternalPackages" : { "type" : "boolean" }, "packageUUID" : { "type" : "string" } }, "type" : "object" }, "GraphSourceDTOAssociationPairDTO" : { "properties" : { "graphColor" : { "type" : "string" }, "graphUri" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/AssociationPairDTO" } }, "type" : "object" }, "GraphSourceDTOAttributeDTO" : { "properties" : { "graphColor" : { "type" : "string" }, "graphUri" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/AttributeDTO" } }, "type" : "object" }, "GraphSourceDTOEnumEntryDTO" : { "properties" : { "graphColor" : { "type" : "string" }, "graphUri" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/EnumEntryDTO" } }, "type" : "object" }, "GraphSourceDTOSuperClassDTO" : { "properties" : { "graphColor" : { "type" : "string" }, "graphUri" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/SuperClassDTO" } }, "type" : "object" }, "ImportWarning" : { "properties" : { "fileName" : { "type" : "string" }, "undisplayableProperties" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ListPackagesResponse" : { "properties" : { "externalPackageList" : { "items" : { "$ref" : "#/components/schemas/PackageDTO" }, "type" : "array" }, "internalPackageList" : { "items" : { "$ref" : "#/components/schemas/PackageDTO" }, "type" : "array" } }, "type" : "object" }, "MergedClassDTO" : { "properties" : { "associationPairs" : { "items" : { "$ref" : "#/components/schemas/GraphSourceDTOAssociationPairDTO" }, "type" : "array" }, "attributes" : { "items" : { "$ref" : "#/components/schemas/GraphSourceDTOAttributeDTO" }, "type" : "array" }, "classUri" : { "type" : "string" }, "enumEntries" : { "items" : { "$ref" : "#/components/schemas/GraphSourceDTOEnumEntryDTO" }, "type" : "array" }, "label" : { "type" : "string" }, "sources" : { "items" : { "$ref" : "#/components/schemas/ClassSourceDTO" }, "type" : "array" }, "stereotypes" : { "items" : { "type" : "string" }, "type" : "array" }, "superClasses" : { "items" : { "$ref" : "#/components/schemas/GraphSourceDTOSuperClassDTO" }, "type" : "array" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "NodeShape" : { "properties" : { "id" : { "type" : "string" }, "triples" : { "type" : "string" } }, "type" : "object" }, "OntologyDTO" : { "properties" : { "entries" : { "items" : { "$ref" : "#/components/schemas/OntologyEntry" }, "type" : "array" }, "namespace" : { "type" : "string" }, "uuid" : { "type" : "string" } }, "type" : "object" }, "OntologyEntry" : { "properties" : { "datatypeIri" : { "type" : "string" }, "iri" : { "type" : "string" }, "isIriEntry" : { "type" : "boolean" }, "value" : { "type" : "string" } }, "type" : "object" }, "OntologyField" : { "properties" : { "datatypeIri" : { "type" : "string" }, "iri" : { "type" : "string" }, "iriEntry" : { "type" : "boolean" }, "isIriEntry" : { "type" : "boolean" } }, "type" : "object" }, "PackageDTO" : { "properties" : { "comment" : { "type" : "string" }, "label" : { "type" : "string" }, "package" : { "$ref" : "#/components/schemas/BelongsToCategoryDTO" }, "prefix" : { "type" : "string" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "PasteClassesRequestDTO" : { "properties" : { "copyAsAbstract" : { "type" : "boolean" }, "copyAssociations" : { "type" : "boolean" }, "copyAttributes" : { "type" : "boolean" }, "copyInheritance" : { "type" : "boolean" }, "referencesToCopy" : { "items" : { "$ref" : "#/components/schemas/URI" }, "type" : "array" }, "sources" : { "items" : { "$ref" : "#/components/schemas/PasteSourceClassDTO" }, "type" : "array" }, "targetPackageUUID" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "PastePreviewRequestDTO" : { "properties" : { "sources" : { "items" : { "$ref" : "#/components/schemas/PasteSourceClassDTO" }, "type" : "array" } }, "type" : "object" }, "PastePreviewResponseDTO" : { "properties" : { "missing" : { "additionalProperties" : { "items" : { "$ref" : "#/components/schemas/PasteReferenceDTO" }, "type" : "array" }, "type" : "object" } }, "type" : "object" }, "PasteReferenceDTO" : { "properties" : { "label" : { "type" : "string" }, "requires" : { "items" : { "$ref" : "#/components/schemas/URI" }, "type" : "array" }, "uri" : { "$ref" : "#/components/schemas/URI" }, "usedBy" : { "items" : { "$ref" : "#/components/schemas/PasteUsageDTO" }, "type" : "array" } }, "type" : "object" }, "PasteSourceClassDTO" : { "properties" : { "classUUID" : { "type" : "string" }, "sourceDatasetName" : { "type" : "string" }, "sourceGraphURI" : { "type" : "string" } }, "type" : "object" }, "PasteUsageDTO" : { "properties" : { "className" : { "type" : "string" }, "memberName" : { "type" : "string" } }, "type" : "object" }, "PropertyOverview" : { "properties" : { "associations" : { "$ref" : "#/components/schemas/ResourceRenameOverviewSemanticAssociationChange" }, "attributes" : { "$ref" : "#/components/schemas/ResourceRenameOverviewSemanticAttributeChange" }, "enumEntries" : { "$ref" : "#/components/schemas/ResourceRenameOverviewSemanticEnumEntryChange" }, "label" : { "type" : "string" } }, "type" : "object" }, "PropertyRenamings" : { "properties" : { "associationRenames" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticAssociationChange" }, "type" : "array" }, "attributeRenames" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticAttributeChange" }, "type" : "array" }, "classLabel" : { "type" : "string" }, "enumEntryRenames" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticEnumEntryChange" }, "type" : "array" } }, "type" : "object" }, "PropertyShape" : { "properties" : { "id" : { "type" : "string" }, "order" : { "format" : "double", "type" : "number" }, "triples" : { "type" : "string" } }, "type" : "object" }, "PropertyShapesWrapper" : { "properties" : { "domain" : { "format" : "uuid", "type" : "string" }, "label" : { "type" : "string" }, "propertyShapes" : { "items" : { "$ref" : "#/components/schemas/PropertyShape" }, "type" : "array" }, "propertyType" : { "type" : "string" } }, "type" : "object" }, "RDFSComment" : { "properties" : { "format" : { "$ref" : "#/components/schemas/URI" }, "value" : { "type" : "string" } }, "type" : "object" }, "RDFSDomain" : { "properties" : { "label" : { "$ref" : "#/components/schemas/RDFSLabel" }, "uri" : { "$ref" : "#/components/schemas/URI" } }, "type" : "object" }, "RDFSLabel" : { "properties" : { "lang" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "RDFSSubClassOf" : { "properties" : { "label" : { "$ref" : "#/components/schemas/RDFSLabel" }, "uri" : { "$ref" : "#/components/schemas/URI" } }, "type" : "object" }, "RenameCandidateSemanticAssociationChange" : { "properties" : { "confidenceScore" : { "format" : "double", "type" : "number" }, "newResource" : { "$ref" : "#/components/schemas/SemanticAssociationChange" }, "oldResource" : { "$ref" : "#/components/schemas/SemanticAssociationChange" } }, "type" : "object" }, "RenameCandidateSemanticAttributeChange" : { "properties" : { "confidenceScore" : { "format" : "double", "type" : "number" }, "newResource" : { "$ref" : "#/components/schemas/SemanticAttributeChange" }, "oldResource" : { "$ref" : "#/components/schemas/SemanticAttributeChange" } }, "type" : "object" }, "RenameCandidateSemanticClassChange" : { "properties" : { "confidenceScore" : { "format" : "double", "type" : "number" }, "newResource" : { "$ref" : "#/components/schemas/SemanticClassChange" }, "oldResource" : { "$ref" : "#/components/schemas/SemanticClassChange" } }, "type" : "object" }, "RenameCandidateSemanticEnumEntryChange" : { "properties" : { "confidenceScore" : { "format" : "double", "type" : "number" }, "newResource" : { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, "oldResource" : { "$ref" : "#/components/schemas/SemanticEnumEntryChange" } }, "type" : "object" }, "RenameCandidateSemanticResourceChange" : { "properties" : { "confidenceScore" : { "format" : "double", "type" : "number" }, "newResource" : { "oneOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "$ref" : "#/components/schemas/SemanticAssociationChange" }, { "$ref" : "#/components/schemas/SemanticAttributeChange" }, { "$ref" : "#/components/schemas/SemanticClassChange" }, { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, { "$ref" : "#/components/schemas/SemanticPackageChange" } ] }, "oldResource" : { "oneOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "$ref" : "#/components/schemas/SemanticAssociationChange" }, { "$ref" : "#/components/schemas/SemanticAttributeChange" }, { "$ref" : "#/components/schemas/SemanticClassChange" }, { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, { "$ref" : "#/components/schemas/SemanticPackageChange" } ] } }, "type" : "object" }, "RenderingDataDTO" : { "properties" : { "format" : { "enum" : [ "MERMAID", "SVELTEFLOW" ], "type" : "string" } }, "type" : "object" }, "ResourceDeleteRequest" : { "properties" : { "action" : { "enum" : [ "DELETE", "KEEP", "REMOVE_PACKAGE_REFERENCE", "REMOVE_SUBCLASS_REFERENCE" ], "type" : "string" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "ResourceIdentifier" : { "properties" : { "label" : { "type" : "string" }, "namespace" : { "type" : "string" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "ResourceRenameOverview" : { "properties" : { "added" : { "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "$ref" : "#/components/schemas/SemanticAssociationChange" }, { "$ref" : "#/components/schemas/SemanticAttributeChange" }, { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, { "$ref" : "#/components/schemas/SemanticPackageChange" } ] }, "type" : "array" }, "deletedAndRenamed" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticResourceChange" }, "type" : "array" }, "modified" : { "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "$ref" : "#/components/schemas/SemanticAssociationChange" }, { "$ref" : "#/components/schemas/SemanticAttributeChange" }, { "$ref" : "#/components/schemas/SemanticClassChange" }, { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, { "$ref" : "#/components/schemas/SemanticPackageChange" } ] }, "type" : "array" } }, "type" : "object" }, "ResourceRenameOverviewSemanticAssociationChange" : { "properties" : { "added" : { "items" : { "$ref" : "#/components/schemas/SemanticAssociationChange" }, "type" : "array" }, "deletedAndRenamed" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticAssociationChange" }, "type" : "array" }, "modified" : { "items" : { "$ref" : "#/components/schemas/SemanticAssociationChange" }, "type" : "array" } }, "type" : "object" }, "ResourceRenameOverviewSemanticAttributeChange" : { "properties" : { "added" : { "items" : { "$ref" : "#/components/schemas/SemanticAttributeChange" }, "type" : "array" }, "deletedAndRenamed" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticAttributeChange" }, "type" : "array" }, "modified" : { "items" : { "$ref" : "#/components/schemas/SemanticAttributeChange" }, "type" : "array" } }, "type" : "object" }, "ResourceRenameOverviewSemanticEnumEntryChange" : { "properties" : { "added" : { "items" : { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, "type" : "array" }, "deletedAndRenamed" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticEnumEntryChange" }, "type" : "array" }, "modified" : { "items" : { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, "type" : "array" } }, "type" : "object" }, "RestoreVersionDTO" : { "properties" : { "versionId" : { "type" : "string" } }, "type" : "object" }, "SHACLToClassRelations" : { "properties" : { "derivedPropertyShapes" : { "items" : { "$ref" : "#/components/schemas/PropertyShapesWrapper" }, "type" : "array" }, "namespaces" : { "type" : "string" }, "nodeShapes" : { "items" : { "$ref" : "#/components/schemas/NodeShape" }, "type" : "array" }, "propertyShapes" : { "items" : { "$ref" : "#/components/schemas/PropertyShapesWrapper" }, "type" : "array" } }, "type" : "object" }, "SchemaValidationIssueDTO" : { "properties" : { "message" : { "type" : "string" }, "resourceUri" : { "type" : "string" }, "severity" : { "enum" : [ "ERROR", "WARNING", "INFO" ], "type" : "string" } }, "type" : "object" }, "SchemaValidationReportDTO" : { "properties" : { "issues" : { "items" : { "$ref" : "#/components/schemas/SchemaValidationIssueDTO" }, "type" : "array" }, "valid" : { "type" : "boolean" } }, "type" : "object" }, "SearchFilter" : { "description" : "The scope where the search is performed.", "properties" : { "datasetName" : { "type" : "string" }, "graphUri" : { "type" : "string" }, "packageUUID" : { "type" : "string" } }, "type" : "object" }, "SearchResult" : { "properties" : { "datasetName" : { "type" : "string" }, "graphUri" : { "type" : "string" }, "label" : { "$ref" : "#/components/schemas/RDFSLabel" }, "packageLabel" : { "$ref" : "#/components/schemas/RDFSLabel" }, "packageUUID" : { "format" : "uuid", "type" : "string" }, "parentClassUUID" : { "format" : "uuid", "type" : "string" }, "parentClassUri" : { "$ref" : "#/components/schemas/URI" }, "type" : { "enum" : [ "CLASS", "PACKAGE", "ATTRIBUTE", "ASSOCIATION", "ENUMTYPE" ], "type" : "string" }, "uri" : { "$ref" : "#/components/schemas/URI" }, "uuid" : { "format" : "uuid", "type" : "string" } }, "type" : "object" }, "SearchResults" : { "properties" : { "externalSearchResults" : { "items" : { "$ref" : "#/components/schemas/SearchResult" }, "type" : "array" }, "internalSearchResults" : { "items" : { "$ref" : "#/components/schemas/SearchResult" }, "type" : "array" } }, "type" : "object" }, "SemanticAssociationChange" : { "allOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "properties" : { "associationUsed" : { "type" : "boolean" }, "mapping" : { "type" : "string" }, "range" : { "type" : "string" } }, "type" : "object" } ] }, "SemanticAttributeChange" : { "allOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "properties" : { "allowedValues" : { "items" : { "type" : "string" }, "type" : "array" }, "dataType" : { "type" : "string" }, "defaultValue" : { "type" : "string" }, "forceDefaultValue" : { "type" : "boolean" }, "optional" : { "type" : "boolean" }, "primitiveDataType" : { "type" : "string" } }, "type" : "object" } ] }, "SemanticClassChange" : { "allOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "properties" : { "associationRenameCandidates" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticAssociationChange" }, "type" : "array" }, "associations" : { "items" : { "$ref" : "#/components/schemas/SemanticAssociationChange" }, "type" : "array" }, "attributeRenameCandidates" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticAttributeChange" }, "type" : "array" }, "attributes" : { "items" : { "$ref" : "#/components/schemas/SemanticAttributeChange" }, "type" : "array" }, "enumEntries" : { "items" : { "$ref" : "#/components/schemas/SemanticEnumEntryChange" }, "type" : "array" }, "enumEntryRenameCandidates" : { "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticEnumEntryChange" }, "type" : "array" } }, "type" : "object" } ] }, "SemanticEnumEntryChange" : { "allOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "properties" : { "allowedValues" : { "items" : { "type" : "string" }, "type" : "array" }, "replacementValue" : { "type" : "string" } }, "type" : "object" } ] }, "SemanticFieldChange" : { "properties" : { "from" : { "type" : "string" }, "semanticFieldChangeType" : { "enum" : [ "LABEL_CHANGE", "COMMENT_CHANGE", "SUPERCLASS_CHANGE", "BELONGS_TO_CATEGORY_CHANGE", "DATATYPE_CHANGE", "DATATYPE_RENAME", "MADE_OPTIONAL", "MADE_REQUIRED", "MULTIPLICITY_CHANGE", "STEREOTYPE_ADDED", "STEREOTYPE_REMOVED", "MADE_ABSTRACT", "DOMAIN_CHANGE", "DOMAIN_RENAME", "TARGET_CHANGE", "ASSOCIATION_USED_CHANGE", "DEFAULT_VALUE_CHANGE", "FIXED_VALUE_CHANGE" ], "type" : "string" }, "to" : { "type" : "string" } }, "type" : "object" }, "SemanticPackageChange" : { "allOf" : [ { "$ref" : "#/components/schemas/SemanticResourceChange" }, { "properties" : { "classChanges" : { "items" : { "$ref" : "#/components/schemas/SemanticClassChange" }, "type" : "array" } }, "type" : "object" } ] }, "SemanticResourceChange" : { "discriminator" : { "propertyName" : "type" }, "properties" : { "changes" : { "items" : { "$ref" : "#/components/schemas/SemanticFieldChange" }, "type" : "array" }, "iri" : { "type" : "string" }, "label" : { "type" : "string" }, "oldIRI" : { "type" : "string" }, "semanticResourceChangeType" : { "enum" : [ "ADD", "ADDED_FROM_INHERITANCE", "DELETE", "DELETED_FROM_INHERITANCE", "CHANGE", "RENAME" ], "type" : "string" }, "type" : { "type" : "string" } }, "required" : [ "type" ], "type" : "object" }, "SuperClassDTO" : { "properties" : { "label" : { "type" : "string" }, "prefix" : { "type" : "string" } }, "type" : "object" }, "TripleClassChange" : { "properties" : { "associations" : { "items" : { "$ref" : "#/components/schemas/TripleResourceChange" }, "type" : "array" }, "attributes" : { "items" : { "$ref" : "#/components/schemas/TripleResourceChange" }, "type" : "array" }, "changes" : { "items" : { "$ref" : "#/components/schemas/TriplePropertyChange" }, "type" : "array" }, "enumEntries" : { "items" : { "$ref" : "#/components/schemas/TripleResourceChange" }, "type" : "array" }, "label" : { "type" : "string" }, "uri" : { "type" : "string" } }, "type" : "object" }, "TriplePackageChange" : { "properties" : { "changes" : { "items" : { "$ref" : "#/components/schemas/TriplePropertyChange" }, "type" : "array" }, "classes" : { "items" : { "$ref" : "#/components/schemas/TripleClassChange" }, "type" : "array" }, "external" : { "type" : "boolean" }, "label" : { "type" : "string" }, "uri" : { "type" : "string" } }, "type" : "object" }, "TriplePropertyChange" : { "properties" : { "from" : { "type" : "string" }, "predicate" : { "type" : "string" }, "to" : { "type" : "string" } }, "type" : "object" }, "TripleResourceChange" : { "properties" : { "changes" : { "items" : { "$ref" : "#/components/schemas/TriplePropertyChange" }, "type" : "array" }, "label" : { "type" : "string" }, "uri" : { "type" : "string" } }, "type" : "object" }, "URI" : { "description" : "When deserializing (parsing json to object), it is possible to alternatively only put a String containing the whole uri. For serializing (parsing object to json), the object structure ist always used.", "properties" : { "prefix" : { "type" : "string" }, "suffix" : { "type" : "string" } }, "type" : "object" } } }, "info" : { "contact" : { "name" : "soptim", "url" : "https://www.soptim.de/" }, "description" : "This API provides utilities for editing RDFGraphs that model UML classes using the CIM standard.", "license" : { "name" : "Apache License 2.0", "url" : "https://www.apache.org/licenses/LICENSE-2.0" }, "title" : "RDFArchitect backend", "version" : "0.0.0" }, "openapi" : "3.1.0", "paths" : { "/api/compare" : { "post" : { "description" : "Compare two given graphs", "operationId" : "compareSchemasFromFiles", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "fileA" : { "description" : "The first graph file.", "format" : "binary", "type" : "string" }, "fileB" : { "description" : "The second graph file.", "format" : "binary", "type" : "string" } }, "required" : [ "fileA", "fileB" ], "type" : "object" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/TriplePackageChange" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "compare schemas", "tags" : [ "comparison" ] } }, "/api/datasets" : { "get" : { "description" : "Lists all non-snapshots datasets including their prefixes and read-only status.", "operationId" : "listDatasets", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "items" : { "$ref" : "#/components/schemas/DatasetDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "List datasets", "tags" : [ "dataset" ] } }, "/api/datasets/{datasetName}" : { "delete" : { "description" : "Deletes a dataset including all of its graphs.", "operationId" : "deleteDataset", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Delete dataset", "tags" : [ "dataset" ] }, "put" : { "description" : "Creates an empty dataset without any graphs.", "operationId" : "createDataset", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" }, "409" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "Dataset already exists" } }, "summary" : "Create dataset", "tags" : [ "dataset" ] } }, "/api/datasets/{datasetName}/content" : { "get" : { "description" : "Export a file storing all RDFSchema graphs from a dataset", "operationId" : "getDatasetSchema", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/n-quads" : { }, "application/trig" : { } }, "description" : "OK" } }, "summary" : "export dataset", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/crossprofilediagram" : { "get" : { "operationId" : "getCrossProfileDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CrossProfileDiagramDTO" } } }, "description" : "OK" } }, "tags" : [ "cross-profile-diagram-rest-controller" ] } }, "/api/datasets/{datasetName}/crossprofilediagramColors" : { "get" : { "operationId" : "getCrossProfileColors", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CrossProfileDiagramColorDataDTO" } } }, "description" : "OK" } }, "tags" : [ "cross-profile-diagram-color-rest-controller" ] }, "put" : { "operationId" : "updateCrossProfileColors", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CrossProfileDiagramColorDataDTO" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } }, "tags" : [ "cross-profile-diagram-color-rest-controller" ] } }, "/api/datasets/{datasetName}/crossprofilediagramID" : { "get" : { "operationId" : "getCrossProfileDiagramId", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "cross-profile-diagram-idrest-controller" ] } }, "/api/datasets/{datasetName}/crossprofilediagramRendering" : { "get" : { "operationId" : "getCrossProfileRenderingData", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/RenderingDataDTO" } } }, "description" : "OK" } }, "tags" : [ "cross-profile-diagram-rendering-rest-controller" ] } }, "/api/datasets/{datasetName}/diagrams" : { "get" : { "description" : "Returns a list of all custom diagrams for the specified dataset. Each diagram includes its ID, name, and other relevant information.", "operationId" : "getCustomDatasetDiagramList", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/CustomDiagramDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "list custom diagrams for dataset", "tags" : [ "diagram" ] } }, "/api/datasets/{datasetName}/diagrams/{diagramId}" : { "delete" : { "operationId" : "deleteCustomDatasetDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-dataset-diagrams-rest-controller" ] }, "get" : { "operationId" : "getCustomDatasetViewRenderingData", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/RenderingDataDTO" } } }, "description" : "OK" } }, "tags" : [ "custom-dataset-diagrams-rest-controller" ] }, "put" : { "operationId" : "replaceCustomDatasetDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDiagramDTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-dataset-diagrams-rest-controller" ] } }, "/api/datasets/{datasetName}/diagrams/{diagramId}/classes" : { "delete" : { "operationId" : "removeFromCustomDatasetDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The list of class uuids to be removed from the diagram", "items" : { "format" : "uuid", "type" : "string" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-dataset-diagram-all-classes-rest-controller" ] }, "post" : { "operationId" : "addToCustomDatasetDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The list of the classes to be added to the diagram", "items" : { "$ref" : "#/components/schemas/ClassInDiagram" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-dataset-diagram-all-classes-rest-controller" ] } }, "/api/datasets/{datasetName}/graphs" : { "get" : { "description" : "Lists all graphs in a specified datasets", "operationId" : "listGraphs", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "items" : { "$ref" : "#/components/schemas/GraphDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "List graphs", "tags" : [ "dataset" ] } }, "/api/datasets/{datasetName}/graphs/content" : { "put" : { "description" : "Replace or insert one or more rdf graphs for the dataset. Accepts multiple files and/or zip archives containing several graph files.", "operationId" : "replaceGraphs", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Optional graph URIs, one per file. Defaults to file names.", "in" : "query", "name" : "graphUris", "required" : false, "schema" : { "items" : { "type" : "string" }, "type" : "array" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "properties" : { "files" : { "description" : "The files containing the graph data", "items" : { "format" : "binary", "type" : "string" }, "type" : "array" } }, "required" : [ "files" ], "type" : "object" } } } }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GraphBulkImportResponse" } } }, "description" : "OK" } }, "summary" : "Replace/Insert multiple graphs", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/asciidocexport/{fileEnding}" : { "get" : { "description" : "Export the rdf-schema graph as asciidoc", "operationId" : "getAsciiDocExport", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The file ending of the diagram files.", "in" : "path", "name" : "fileEnding", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Whether the package diagram is shown in the document instead of only being linked.", "in" : "query", "name" : "embedDiagrams", "required" : false, "schema" : { "default" : false, "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "text/asciidoc" : { } }, "description" : "OK" } }, "summary" : "export graph as asciidoc", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/canRedo" : { "post" : { "description" : "Check whether the last undone change can be redone", "operationId" : "canRedo", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "boolean" } } }, "description" : "OK" } }, "summary" : "can Redo", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/canUndo" : { "post" : { "description" : "Check whether an undo operation is possible.", "operationId" : "canUndo", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "boolean" } } }, "description" : "OK" } }, "summary" : "can undo", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/changes" : { "get" : { "description" : "Get a list containing all changes made to a graph", "operationId" : "getChangeLog", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLog" } } }, "description" : "OK" } }, "summary" : "list changes for graph", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes" : { "get" : { "description" : "Get a list containing all classes. Doesn't include: stereotypes, attributes and associations.", "operationId" : "getClassList", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Whether to include external classes.", "in" : "query", "name" : "includeExternalClasses", "required" : false, "schema" : { "default" : false, "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ClassUMLAdaptedDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "list classes", "tags" : [ "graph" ] }, "post" : { "description" : "Create a new class with default name and no attributes, stereotypes or associations. Because no concrete stereotype is added the class is abstract by default.", "operationId" : "addClass", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddNewClassRequest" } } }, "description" : "Helper record, functions as DTO for accepting the necessary information for adding a new class", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "create new class", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}" : { "delete" : { "description" : "Deletes a whole class.", "operationId" : "deleteClass", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Delete class", "tags" : [ "class" ] }, "get" : { "description" : "Get all information about a specified class.", "operationId" : "getClassInformation", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Whether to recursively expand the superclass hierarchy (with their attributes and associations).", "in" : "query", "name" : "includeSuperClasses", "required" : false, "schema" : { "default" : false, "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClassUMLAdaptedDTO" } } }, "description" : "OK" } }, "summary" : "Get class information", "tags" : [ "class" ] }, "put" : { "description" : "Replace a whole class.", "operationId" : "replaceClass", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClassUMLAdaptedDTO" } } }, "description" : "The new class", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace class", "tags" : [ "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/associations" : { "post" : { "description" : "Creates a new association for a specified class.", "operationId" : "createAssociation", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssociationPairDTO" } } }, "description" : "The new association", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AssociationUUIDs" } } }, "description" : "OK" } }, "summary" : "Creates association", "tags" : [ "class" ] }, "put" : { "description" : "Replaces all associations of a specified class.", "operationId" : "replaceAllAssociations", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/AssociationPairDTO" }, "type" : "array" } } }, "description" : "The new association", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace all association", "tags" : [ "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/associations/{associationUUID}" : { "put" : { "description" : "Replaces an association of a specified class.", "operationId" : "replaceAssociation", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The old, to be replaced association.", "in" : "path", "name" : "associationUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssociationPairDTO" } } }, "description" : "The new association", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AssociationUUIDs" } } }, "description" : "OK" } }, "summary" : "Replace/Create association", "tags" : [ "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/associations/{associationUUID}/shacl" : { "get" : { "description" : "GET the shacl rules that can be related to a specified association.", "operationId" : "getAssociationSHACL", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the association.", "in" : "path", "name" : "associationUUID", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomAndGeneratedTupleListPropertyShape" } } }, "description" : "OK" } }, "summary" : "Get SHACL related to an association", "tags" : [ "shacl" ] }, "put" : { "description" : "Replace the SHACL rules of an association.", "operationId" : "replaceAssociationSHACL", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the association.", "in" : "path", "name" : "associationUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The SHACL shapes to be inserted.", "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "replace SHACL of an association", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/attributes" : { "post" : { "description" : "Creates a new attribute for a specified class.", "operationId" : "createAttribute", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttributeDTO" } } }, "description" : "The new attribute", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "uuid", "type" : "string" } } }, "description" : "OK" } }, "summary" : "Create attribute", "tags" : [ "class" ] }, "put" : { "description" : "Replaces all attributes of a specified class.", "operationId" : "replaceAllAttributes", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/CIMAttribute" }, "type" : "array" } } }, "description" : "The new attribute", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace all attributes", "tags" : [ "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/attributes/{attributeUUID}" : { "put" : { "description" : "Replaces an attribute of a specified class.", "operationId" : "replaceAttribute", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the old, to be replaced attribute.", "in" : "path", "name" : "attributeUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttributeDTO" } } }, "description" : "The new attribute", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "uuid", "type" : "string" } } }, "description" : "The uuid of the new attribute." } }, "summary" : "Replace/Create attribute", "tags" : [ "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/attributes/{attributeUUID}/shacl" : { "get" : { "description" : "GET the shacl rules that can be related to a specified attribute.", "operationId" : "getAttributeSHACL", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the attribute.", "in" : "path", "name" : "attributeUUID", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomAndGeneratedTupleListPropertyShape" } } }, "description" : "OK" } }, "summary" : "Get SHACL related to an attribute", "tags" : [ "shacl" ] }, "put" : { "description" : "Replace the SHACL rules of an attribute.", "operationId" : "replaceAttributeSHACL", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the association.", "in" : "path", "name" : "attributeUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The SHACL shapes to be inserted.", "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "replace SHACL of an attribute", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/enumentries" : { "post" : { "description" : "Creates a new enum entry for a specified class.", "operationId" : "createEnumEntry", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the enum.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EnumEntryDTO" } } }, "description" : "The new enum entry.", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "uuid", "type" : "string" } } }, "description" : "UUID of the newly created enum entry." } }, "summary" : "Create enum entry", "tags" : [ "enum" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/enumentries/{enumEntryUUID}" : { "put" : { "description" : "Replaces the enum entry for a given enum URI and labels", "operationId" : "replaceEnumEntry", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the enum.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the enum entry.", "in" : "path", "name" : "enumEntryUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EnumEntryDTO" } } }, "description" : "The new enum entry.", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "uuid", "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace enum entry", "tags" : [ "enum" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/extend" : { "post" : { "description" : "extends a class in another graph", "operationId" : "extendClass", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttributeDTO" } } }, "description" : "The new attribute", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ClassDTO" } } }, "description" : "OK" } }, "summary" : "Extend class", "tags" : [ "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/referencedByClasses" : { "get" : { "description" : "Get all classes referencing this class.", "operationId" : "getClassesReferencingThisClass", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ClassRelationsDTO" } } }, "description" : "OK" } }, "summary" : "Get classes referencing this class", "tags" : [ "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/shacl" : { "get" : { "description" : "Get the shacl rules that can be related to a specified class.", "operationId" : "getSHACLRelatedToClass", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomAndGeneratedTupleSHACLToClassRelations" } } }, "description" : "OK" } }, "summary" : "Get SHACL related to a class", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/shacl/custom" : { "put" : { "description" : "Replace or insert SHACL rules related to a class.", "operationId" : "putSHACL", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The SHACL shapes to be inserted.", "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace or insert SHACL", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/classes/{classUUID}/shacl/propertyShapes" : { "get" : { "description" : "Get the shacl rules that can be related to a specified class.", "operationId" : "getPropertyShapes", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the class.", "in" : "path", "name" : "classUUID", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "items" : { "$ref" : "#/components/schemas/PropertyShapesWrapper" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "Get SHACL related to a class", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/compare" : { "get" : { "description" : "Compare two graphs stored in the database", "operationId" : "compareStoredSchemas", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the base dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the base graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The literal name of the dataset to compare against.", "in" : "query", "name" : "otherDataset", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph to compare against.", "in" : "query", "name" : "otherGraph", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/TriplePackageChange" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "compare schemas", "tags" : [ "comparison" ] }, "post" : { "description" : "Compare a given graph with the specified graph from the dataset", "operationId" : "compareSchemas", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "file" : { "description" : "The file containing the graph to be compared.", "format" : "binary", "type" : "string" } }, "required" : [ "file" ], "type" : "object" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/TriplePackageChange" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "compare schemas", "tags" : [ "comparison" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/content" : { "delete" : { "description" : "Delete an rdf-schema graph", "operationId" : "deleteGraph", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "delete graph", "tags" : [ "graph" ] }, "get" : { "description" : "Export the rdf-schema graph", "operationId" : "getSchema", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/n-triples" : { }, "application/rdf+json" : { }, "application/rdf+xml" : { }, "text/turtle" : { } }, "description" : "OK" } }, "summary" : "export graph", "tags" : [ "graph" ] }, "put" : { "description" : "Replace or insert an rdf-schema graph", "operationId" : "replaceGraph", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "file" : { "description" : "The file containing the graph to be inserted", "format" : "binary", "type" : "string" } }, "type" : "object" } } } }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace/Insert graph", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/datatypes" : { "get" : { "description" : "Get a list of datatypes/classes. Doesn't include: Primitive Datatypes, stereotypes, attributes and associations.", "operationId" : "listDatatypes", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ClassUMLAdaptedDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "list datatypes", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/delete-requests" : { "post" : { "description" : "Processes a list of delete requests, each specifying a resource UUID and the desired action.", "operationId" : "deleteResources", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "A list of resource delete requests, each containing the uuid of the resource to delete and the type of deletion", "items" : { "$ref" : "#/components/schemas/ResourceDeleteRequest" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Delete resources", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/deletion-impact" : { "post" : { "description" : "Returns, per requested UUID, a tree of affected resources for deleting that resource.", "operationId" : "getDeletionImpact", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The uuids of the cim resources to analyse.", "items" : { "format" : "uuid", "type" : "string" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "additionalProperties" : { "$ref" : "#/components/schemas/AffectedResource" }, "type" : "object" } } }, "description" : "OK" } }, "summary" : "Get deletion impact", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/diagrams" : { "get" : { "description" : "Returns a list of all custom diagrams for the specified graph. Each diagram includes its ID, name, and other relevant information.", "operationId" : "getCustomGraphDiagramList", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/CustomDiagramDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "list custom diagrams for graph", "tags" : [ "diagram" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/diagrams/{diagramId}" : { "delete" : { "operationId" : "deleteCustomGraphDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-diagrams-rest-controller" ] }, "get" : { "operationId" : "getCustomProfileViewRenderingData", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/RenderingDataDTO" } } }, "description" : "OK" } }, "tags" : [ "custom-diagrams-rest-controller" ] }, "put" : { "operationId" : "replaceCustomGraphDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDiagramDTO" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-diagrams-rest-controller" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/diagrams/{diagramId}/classes" : { "delete" : { "operationId" : "removeFromDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The list of class uuids to be removed from the diagram", "items" : { "format" : "uuid", "type" : "string" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-diagram-all-classes-rest-controller" ] }, "post" : { "operationId" : "addToCustomGraphDiagram", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The uuid of the diagram.", "in" : "path", "name" : "diagramId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The list of the classes to be added to the diagram", "items" : { "$ref" : "#/components/schemas/ClassInDiagram" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "tags" : [ "custom-diagram-all-classes-rest-controller" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/htmlexport/{fileEnding}" : { "get" : { "description" : "Export the rdf-schema graph as html", "operationId" : "getHTMLExport", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The file ending of the diagram files.", "in" : "path", "name" : "fileEnding", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Whether the package diagram is shown in the document instead of only being linked.", "in" : "query", "name" : "embedDiagrams", "required" : false, "schema" : { "default" : false, "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "text/html" : { } }, "description" : "OK" } }, "summary" : "export graph as html", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/layout/{diagramUUID}/classes" : { "put" : { "description" : "Updates the positions for all the classes provided in the request body with the provided coordinates.", "operationId" : "updateClassPositions", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The UUID of the package or custom diagram being updated.", "in" : "path", "name" : "diagramUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ClassPositionDTO" }, "type" : "array" } } }, "description" : "The DTO with necessary information for class reposition", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "updates class positions", "tags" : [ "diagram", "layout", "class" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/ontology" : { "delete" : { "description" : "Deletes the currently stored ontology.", "operationId" : "deleteOntology", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Delete ontology", "tags" : [ "ontology" ] }, "get" : { "description" : "Get the currently stored ontology. null if none stored.", "operationId" : "getOntology", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OntologyDTO" } } }, "description" : "OK" } }, "summary" : "Get ontology", "tags" : [ "ontology" ] }, "post" : { "description" : "create a new ontology.", "operationId" : "createOntology", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OntologyDTO" } } }, "description" : "The new ontology", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Create ontology", "tags" : [ "ontology" ] }, "put" : { "description" : "Replace the currently stored ontology with a new one.", "operationId" : "replaceOntology", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OntologyDTO" } } }, "description" : "The new ontology", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace ontology", "tags" : [ "ontology" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/ontology/generate" : { "get" : { "description" : "Get the Ontology fields that can be automatically generated.", "operationId" : "getOntologyEntries", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/OntologyEntry" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "Get generated ontology entries", "tags" : [ "ontology" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/packages" : { "get" : { "description" : "Get two lists of packages: internal and external packages.", "operationId" : "listPackages", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ListPackagesResponse" } } }, "description" : "OK" } }, "summary" : "list packages", "tags" : [ "graph" ] }, "post" : { "description" : "Create a new package with a given name and optional comment, sub-package relation is nulled", "operationId" : "addPackage", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PackageDTO" } } }, "description" : "DTO for the package to be created", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "format" : "uuid", "type" : "string" } } }, "description" : "OK" } }, "summary" : "create new package", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/packages/{packageUUID}" : { "delete" : { "description" : "Deletes a package by UUID.", "operationId" : "deletePackage", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The UUID of the package to be deleted.", "in" : "path", "name" : "packageUUID", "required" : true, "schema" : { "format" : "uuid", "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "delete package", "tags" : [ "package", "graph" ] }, "get" : { "description" : "Returns the package DTO for the given UUID.", "operationId" : "getPackage", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The UUID of the package to retrieve.", "in" : "path", "name" : "packageUUID", "required" : true, "schema" : { "format" : "uuid", "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PackageDTO" } } }, "description" : "OK" } }, "summary" : "get package", "tags" : [ "package", "graph" ] }, "put" : { "description" : "Replaces a whole package.", "operationId" : "replacePackage", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The UUID of the package to be replaced.", "in" : "path", "name" : "packageUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PackageDTO" } } }, "description" : "DTO for the package to be replaced", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "replace package", "tags" : [ "package", "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/primitives" : { "get" : { "description" : "Get a list of primitive datatypes/classes. Doesn't include: stereotypes, attributes and associations.", "operationId" : "listPrimitives", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ClassUMLAdaptedDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "list primitives", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/redo" : { "post" : { "description" : "Redo the last undone change", "operationId" : "redo", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "redo ", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/rename" : { "post" : { "description" : "Renames a graph within its dataset, keeping its content and history. References to the graph, i.e. in custom diagrams, are rewritten. If a new keyword is given, it replaces the dcat:keyword of the profile header.", "operationId" : "renameGraph", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri to rename the graph to.", "in" : "query", "name" : "newGraphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The display name to store as dcat:keyword in the profile header.", "in" : "query", "name" : "newKeyword", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" }, "409" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "Graph URI already exists" } }, "summary" : "Rename graph", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/rendering" : { "post" : { "description" : "Returns rendering data for UML diagrams. The content varies based on environment configuration (Mermaid or Svelteflow).", "operationId" : "getRenderingDataParameterized", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GraphFilter" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RenderingDataDTO" } } }, "description" : "Rendering data (Mermaid or Svelteflow)" } }, "summary" : "Get rendering data", "tags" : [ "svelteflow", "mermaid" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/resolve/iri/{iriIdentifier}" : { "get" : { "description" : "Resolve iri identifier of a cim resource to its uuid.", "operationId" : "resolveIri", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded iri identifier of the cim resource.", "in" : "path", "name" : "iriIdentifier", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "resolve iri identifier", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/restore" : { "post" : { "description" : "restores the graph to the state specified by the version id", "operationId" : "restoreVersion", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestoreVersionDTO" } } }, "description" : "The ID of the version to restore.", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "restore ", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/combined/file" : { "get" : { "description" : "Export the combined rdf-shacl graph of the generated and custom shapes for a graph.", "operationId" : "getCombinedSHACLAsFile", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/n-triples" : { }, "application/rdf+json" : { }, "application/rdf+xml" : { }, "text/turtle" : { } }, "description" : "OK" } }, "summary" : "export shacl", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/custom/file" : { "get" : { "description" : "Export the rdf-shacl graph", "operationId" : "getCustomSHACLAsFile", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/n-triples" : { }, "application/rdf+json" : { }, "application/rdf+xml" : { }, "text/turtle" : { } }, "description" : "OK" } }, "summary" : "export shacl", "tags" : [ "shacl" ] }, "put" : { "description" : "Replace or insert a shacl graph stored in a file", "operationId" : "replaceGraphWithFile", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "properties" : { "file" : { "description" : "The file containing the shacl graph to be inserted", "format" : "binary", "type" : "string" } }, "required" : [ "file" ], "type" : "object" } } } }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace/Insert shacl", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/custom/namespaces/ttl" : { "get" : { "description" : "Export the namespaces of the custom SHACL graph for a given graph identifier.", "operationId" : "getCustomSHACLNamespacesAsString", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "text/turtle" : { } }, "description" : "OK" } }, "summary" : "export custom SHACL namespaces", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/custom/string" : { "get" : { "description" : "Export the rdf-shacl graph as String", "operationId" : "getCustomSHACLAsString", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "text/turtle" : { } }, "description" : "OK" } }, "summary" : "export shacl", "tags" : [ "shacl" ] }, "put" : { "description" : "Replace or insert a shacl graph stored in a Turtle String", "operationId" : "replaceGraphWithGraphString", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The entire SHACL graph as a string", "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace/Insert shacl", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/custom/{shaclShapeURI}" : { "delete" : { "description" : "Delete a shacl shape form a shacl graph", "operationId" : "deleteShape", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The property shape to delete.", "in" : "path", "name" : "shaclShapeURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "delete a shacl shape", "tags" : [ "shacl" ] }, "put" : { "description" : "Replace or insert a shacl shape from a shacl graph with the given triples in a valid turtle syntax.", "operationId" : "replaceShape", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The property shape to replace.", "in" : "path", "name" : "shaclShapeURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "the triples to replace, requires valid turtle syntax.", "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace/Insert shacl shape", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/generate/file" : { "get" : { "description" : "Export the rdf-shacl graph as a file", "operationId" : "getGeneratedSHACLAsFile", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/n-triples" : { }, "application/rdf+json" : { }, "application/rdf+xml" : { }, "text/turtle" : { } }, "description" : "OK" } }, "summary" : "export shacl", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/generate/string" : { "get" : { "description" : "generate shacl for the whole graph and return it as a Turtle string.", "operationId" : "getGeneratedSHACLAsString", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "generate shacl", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/shacl/generated/namespaces/ttl" : { "get" : { "description" : "Export the namespaces of the generated SHACL graph for a given graph identifier.", "operationId" : "getGeneratedSHACLNamespacesAsString", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "text/turtle" : { } }, "description" : "OK" } }, "summary" : "export generated SHACL namespaces", "tags" : [ "shacl" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/stereotypes" : { "get" : { "description" : "Get a list of all occurring stereotypes in the graph.", "operationId" : "listStereotypes", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "list stereotypes", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/undo" : { "post" : { "description" : "Undo the last change", "operationId" : "undo", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "undo ", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/validate/{cgmesVersion}" : { "get" : { "description" : "Validates the RDFS schema of a graph for completeness, including the profile header.", "operationId" : "validateSchema", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "cgmesVersion", "required" : true, "schema" : { "enum" : [ "V2_4_15", "V3_0" ], "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SchemaValidationReportDTO" } } }, "description" : "OK" } }, "summary" : "Validate schema", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/graphs/{graphURI}/writeToDatabase" : { "post" : { "description" : "Write a graph to a database to persist it.", "operationId" : "writeToDatabase", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the graph, or \"default\" to access the default graph.", "in" : "path", "name" : "graphURI", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Write to database", "tags" : [ "graph" ] } }, "/api/datasets/{datasetName}/layout/{diagramUUID}/classes" : { "put" : { "description" : "Updates the positions for all the classes provided in the request body with the provided coordinates.", "operationId" : "updateDatasetClassPositions", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The UUID of the package or custom diagram being updated.", "in" : "path", "name" : "diagramUUID", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ClassPositionDTO" }, "type" : "array" } } }, "description" : "The DTO with necessary information for class reposition", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "updates class positions on dataset level", "tags" : [ "diagram", "layout", "class" ] } }, "/api/datasets/{datasetName}/namespaces" : { "get" : { "description" : "Get a list of namespaces stored in a specified dataset.", "operationId" : "listNamespaces", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/CIMPrefixPair" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "List namespaces", "tags" : [ "dataset" ] }, "put" : { "description" : "Replace all namespaces of a specified dataset.", "operationId" : "replaceNamespaces", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The new Namespaces.", "items" : { "$ref" : "#/components/schemas/CIMPrefixPair" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Replace namespaces", "tags" : [ "dataset" ] } }, "/api/datasets/{datasetName}/namespaces/{format}" : { "get" : { "description" : "Get a list of namespaces stored in a specified dataset formatted in a specified format.", "operationId" : "listFormattedNamespaces", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The format of the namespaces.", "in" : "path", "name" : "format", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "List formatted namespaces", "tags" : [ "dataset" ] } }, "/api/datasets/{datasetName}/readonly" : { "delete" : { "description" : "Disables editing for specified dataset", "operationId" : "disableEditing", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "disable editing", "tags" : [ "dataset", "read-only" ] }, "get" : { "description" : "Check whether dataset is read-only", "operationId" : "isReadOnly", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "boolean" } } }, "description" : "OK" } }, "summary" : "is read only", "tags" : [ "dataset", "read-only" ] }, "put" : { "description" : "Enables editing for specified dataset", "operationId" : "enableEditing", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "enable editing", "tags" : [ "dataset", "read-only" ] } }, "/api/datasets/{datasetName}/rename" : { "post" : { "description" : "Renames a dataset, keeping all of its graphs, diagrams and namespaces.", "operationId" : "renameDataset", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "datasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The literal name to rename the dataset to.", "in" : "query", "name" : "newDatasetName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "Rename dataset", "tags" : [ "dataset" ] } }, "/api/datasets/{targetDatasetName}/graphs/{targetGraphURI}/paste" : { "post" : { "description" : "Create copies of one or more previously copied classes in the target graph. A referenced data type listed in referencesToCopy also brings the data types its own attributes need.", "operationId" : "pasteClasses", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the target dataset.", "in" : "path", "name" : "targetDatasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the target graph, or \"default\" to access the default graph.", "in" : "path", "name" : "targetGraphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasteClassesRequestDTO" } } }, "description" : "The target package, copy options and the list of source classes to paste.", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "items" : { "$ref" : "#/components/schemas/CopyClassResponseDTO" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "paste classes", "tags" : [ "paste-rest-controller" ] } }, "/api/datasets/{targetDatasetName}/graphs/{targetGraphURI}/paste/preview" : { "post" : { "description" : "Report which data types, association targets and super classes of the given source classes the target graph does not contain yet.", "operationId" : "previewPaste", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the target dataset.", "in" : "path", "name" : "targetDatasetName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The url encoded uri of the target graph, or \"default\" to access the default graph.", "in" : "path", "name" : "targetGraphURI", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PastePreviewRequestDTO" } } }, "description" : "The list of source classes that would be pasted.", "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PastePreviewResponseDTO" } } }, "description" : "OK" } }, "summary" : "preview paste", "tags" : [ "paste-rest-controller" ] } }, "/api/migrations/class-renamings" : { "get" : { "description" : "Provides an overview of the migration classes including added, modified, deleted and potentially renamed classes.", "operationId" : "getClassRenamings", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/ResourceRenameOverview" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "migration class overview", "tags" : [ "migration" ] }, "post" : { "description" : "Confirms the previously suggested renamed classes and updates the migration context accordingly.", "operationId" : "confirmRenamedClasses", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The updated class renamings", "items" : { "$ref" : "#/components/schemas/RenameCandidateSemanticClassChange" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } }, "summary" : "confirm renamed classes", "tags" : [ "migration" ] } }, "/api/migrations/context" : { "delete" : { "description" : "Resets the current migration context, removing all stored data related to the ongoing migration session.", "operationId" : "clearMigrationContext", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } }, "summary" : "reset migration context", "tags" : [ "migration" ] }, "post" : { "description" : "Computes the diff of two given graphs and stores it in the session for later usage in migration endpoints. Accepts the graphs either as file uploads, GraphIdentifiers or a combination of both.", "operationId" : "computeMigrationContext", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "Dataset of graph A. Required together with graph_uri_a when not uploading graph A as a file.", "in" : "query", "name" : "datasetA", "required" : false, "schema" : { "type" : "string" } }, { "description" : "URI of graph A. Required together with dataset_a when not uploading graph A as a file.", "in" : "query", "name" : "graphA", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Dataset of graph B. Required together with graph_uri_b when not uploading graph B as a file.", "in" : "query", "name" : "datasetB", "required" : false, "schema" : { "type" : "string" } }, { "description" : "URI of graph B. Required together with dataset_b when not uploading graph B as a file.", "in" : "query", "name" : "graphB", "required" : false, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "properties" : { "fileA" : { "description" : "The file containing graph A. Mutually exclusive with dataset_a and graph_uri_a.", "format" : "binary", "type" : "string" }, "fileB" : { "description" : "The file containing graph B. Mutually exclusive with dataset_b and graph_uri_b.", "format" : "binary", "type" : "string" } }, "type" : "object" } } } }, "responses" : { "200" : { "description" : "OK" } }, "summary" : "compute migration context", "tags" : [ "migration" ] } }, "/api/migrations/default-values" : { "get" : { "description" : "Provides an overview of attributes that require default values to be set for migration.", "operationId" : "getDefaultValuesViews", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "items" : { "$ref" : "#/components/schemas/DefaultValueView" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "get default values overview", "tags" : [ "migration" ] }, "post" : { "description" : "Sets the default values for attributes as provided by the user.", "operationId" : "submitDefaultValues", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The updated default values for attributes.", "items" : { "$ref" : "#/components/schemas/DefaultValueView" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } }, "summary" : "submit default values", "tags" : [ "migration" ] } }, "/api/migrations/export" : { "get" : { "description" : "Generates a migration script based on the previously computed migration actions and the shacl shapes of the new schema.", "operationId" : "generateMigrationScript", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/zip" : { } }, "description" : "OK" } }, "summary" : "generate migration script", "tags" : [ "migration" ] } }, "/api/migrations/property-renames" : { "get" : { "description" : "Provides an overview of the properties on migration classes including added, modified, deleted and potentially renamed properties.", "operationId" : "migrationPropertiesOverview", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/PropertyOverview" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "migration class property overview", "tags" : [ "migration" ] }, "post" : { "description" : "Confirms the previously suggested renamed properties and updates the migration context accordingly.", "operationId" : "confirmRenamedProperties", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The updated property renames", "items" : { "$ref" : "#/components/schemas/PropertyRenamings" }, "type" : "array" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } }, "summary" : "confirm renamed properties", "tags" : [ "migration" ] } }, "/api/ontology-fields" : { "get" : { "description" : "Get a list of all known ontology fields.", "operationId" : "getKnownOntologyFields", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/OntologyField" }, "type" : "array" } } }, "description" : "OK" } }, "summary" : "Get known ontology fields", "tags" : [ "ontology" ] } }, "/api/primitiveDatatypes" : { "get" : { "description" : "Get a list of all supported xsd datatypes.", "operationId" : "getPrimitiveDatatypes", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/URI" }, "type" : "array" } } }, "description" : "A list containing the uris of xsd datatypes." } }, "summary" : "Get primitive datatypes", "tags" : [ "data" ] } }, "/api/search" : { "post" : { "description" : "Searches the given graph for a specific query", "operationId" : "search", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The query to search for", "in" : "query", "name" : "query", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SearchFilter" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/SearchResults" } } }, "description" : "OK" } }, "summary" : "Search the graph", "tags" : [ "dataset" ] } }, "/api/session" : { "delete" : { "description" : "Invalidates the current session, discarding all unsaved changes. A new session is created on the next request.", "operationId" : "resetSession", "responses" : { "204" : { "description" : "No Content" } }, "summary" : "Reset session", "tags" : [ "session" ] } }, "/api/snapshots" : { "post" : { "description" : "Creates a snapshot for a dataset and persists it in the database", "operationId" : "createSnapshot", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "description" : "The literal name of the dataset.", "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "snapshot dataset", "tags" : [ "snapshot", "dataset" ] } }, "/api/snapshots/{base64Token}" : { "get" : { "description" : "Fetch a snapshot", "operationId" : "loadSnapshot", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "description" : "The literal name of the dataset.", "in" : "path", "name" : "base64Token", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK" } }, "summary" : "get snapshot", "tags" : [ "snapshot", "dataset" ] } }, "/api/validate/{cgmesVersion}" : { "post" : { "description" : "Validates the RDFS schema of a given graph file for completeness, including the profile header.", "operationId" : "validateFile", "parameters" : [ { "description" : "The name/url of the inquirer.", "in" : "header", "name" : "Origin", "required" : false, "schema" : { "default" : "unknown", "type" : "string" } }, { "in" : "path", "name" : "cgmesVersion", "required" : true, "schema" : { "enum" : [ "V2_4_15", "V3_0" ], "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "properties" : { "file" : { "description" : "The graph file to validate.", "format" : "binary", "type" : "string" } }, "required" : [ "file" ], "type" : "object" } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SchemaValidationReportDTO" } } }, "description" : "OK" } }, "summary" : "Validate schema", "tags" : [ "schema-validation-from-file-rest-controller" ] } } } }