{ "swagger" : "2.0", "info" : { "description" : "Core application for storage and analysis of IT landscape data", "version" : "4.0.326", "title" : "LeanIX Pathfinder REST API" }, "basePath" : "/services/pathfinder/v1", "tags" : [ { "name" : "assets", "description" : "Download of assets" }, { "name" : "bookmarks", "description" : "Manage bookmarks" }, { "name" : "documents", "description" : "Download of documents" }, { "name" : "exports", "description" : "Im- and Export data" }, { "name" : "factSheets", "description" : "Manage Fact Sheets" }, { "name" : "features", "description" : "Get features" }, { "name" : "graphql", "description" : "Process GraphQL requests" }, { "name" : "models", "description" : "Manage data models and authorization" }, { "name" : "settings", "description" : "Get and update workspace settings" }, { "name" : "suggestions", "description" : "Retrieves a list of suggestions for a given search term" }, { "name" : "todos", "description" : "Manage TODOs" } ], "paths" : { "/assets/{asset}" : { "get" : { "tags" : [ "assets" ], "summary" : "downloadAsset", "description" : "Download an asset", "operationId" : "downloadAsset", "produces" : [ "image/*" ], "parameters" : [ { "name" : "asset", "in" : "path", "required" : true, "type" : "string", "enum" : [ "LOGO_EXPORT", "FAVICON", "LOGO_MENU", "MENU_BACKGROUND" ] } ], "responses" : { "default" : { "description" : "successful operation" } }, "security" : [ { "token" : [ ] } ] }, "post" : { "tags" : [ "assets" ], "summary" : "upsertAsset", "description" : "Upsert an asset", "operationId" : "upsertAsset", "consumes" : [ "multipart/form-data" ], "parameters" : [ { "name" : "asset", "in" : "path", "required" : true, "type" : "string", "enum" : [ "LOGO_EXPORT", "FAVICON", "LOGO_MENU", "MENU_BACKGROUND" ] } ], "responses" : { "default" : { "description" : "successful operation" } }, "security" : [ { "token" : [ ] } ] }, "delete" : { "tags" : [ "assets" ], "summary" : "deleteAsset", "description" : "Delete an asset", "operationId" : "deleteAsset", "parameters" : [ { "name" : "asset", "in" : "path", "required" : true, "type" : "string", "enum" : [ "LOGO_EXPORT", "FAVICON", "LOGO_MENU", "MENU_BACKGROUND" ] } ], "responses" : { "default" : { "description" : "successful operation" } }, "security" : [ { "token" : [ ] } ] } }, "/bookmarks" : { "get" : { "tags" : [ "bookmarks" ], "summary" : "getBookmarks", "description" : "Retrieves all stored bookmarks a user can read.", "operationId" : "getBookmarks", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "bookmarkType", "in" : "query", "description" : "Specifies the bookmark type", "required" : true, "type" : "string", "enum" : [ "INVENTORY", "REPORTING", "VISUALIZER", "DASHBOARD", "INVENTORY_EXPORT" ] }, { "name" : "groupKey", "in" : "query", "description" : "A key used to separate bookmarks within the same query type", "required" : false, "type" : "string" }, { "name" : "sharingType", "in" : "query", "description" : "Specifies the sharing type which the returned bookmarks need to have", "required" : false, "type" : "string", "enum" : [ "PRIVATE", "PUBLISHED", "SHARED", "SYSTEM" ] } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/BookmarkListResponse" } } }, "security" : [ { "token" : [ ] } ] }, "post" : { "tags" : [ "bookmarks" ], "summary" : "createBookmark", "description" : "Saves a bookmark in the database", "operationId" : "createBookmark", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "bookmark", "required" : false, "schema" : { "$ref" : "#/definitions/Bookmark" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/BookmarkResponse" } } }, "security" : [ { "token" : [ ] } ] } }, "/bookmarks/{id}" : { "get" : { "tags" : [ "bookmarks" ], "summary" : "getBookmark", "description" : "Retrieves a bookmark by ID", "operationId" : "getBookmark", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/BookmarkResponse" } }, "403" : { "description" : "Permission denied" }, "404" : { "description" : "Bookmark not found" } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "bookmarks" ], "summary" : "updateBookmark", "description" : "Updates a bookmark stored in the database", "operationId" : "updateBookmark", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "in" : "body", "name" : "body", "description" : "bookmark", "required" : false, "schema" : { "$ref" : "#/definitions/Bookmark" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/BookmarkResponse" } } }, "security" : [ { "token" : [ ] } ] }, "delete" : { "tags" : [ "bookmarks" ], "summary" : "deleteBookmark", "description" : "Deletes a bookmark identified by the given ID", "operationId" : "deleteBookmark", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "204" : { "description" : "Deletion successful" }, "403" : { "description" : "No permission to delete relation" }, "404" : { "description" : "Invalid ID supplied" }, "500" : { "description" : "Deletion successful" } }, "security" : [ { "token" : [ ] } ] } }, "/bookmarks/{id}/workingCopy" : { "put" : { "tags" : [ "bookmarks" ], "summary" : "updateWorkingCopy", "description" : "Updates a working copy for a bookmark stored in the database", "operationId" : "updateWorkingCopy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "in" : "body", "name" : "body", "description" : "workingCopy", "required" : false, "schema" : { "$ref" : "#/definitions/BookmarkWorkingCopy" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/BookmarkResponse" } } }, "security" : [ { "token" : [ ] } ] }, "delete" : { "tags" : [ "bookmarks" ], "summary" : "deleteWorkingCopy", "description" : "Deletes a working copy for a bookmark stored in the database", "operationId" : "deleteWorkingCopy", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/BookmarkResponse" } } }, "security" : [ { "token" : [ ] } ] } }, "/documents/{documentId}/download" : { "get" : { "tags" : [ "documents" ], "summary" : "downloadDocument", "description" : "Download a document's content", "operationId" : "downloadDocument", "parameters" : [ { "name" : "documentId", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } }, "security" : [ { "token" : [ ] } ] } }, "/exports" : { "get" : { "tags" : [ "exports" ], "summary" : "getExports", "description" : "Lists all exports of the given type in the workspace of the authorized user", "operationId" : "getExports", "produces" : [ "application/json" ], "parameters" : [ { "name" : "exportType", "in" : "query", "description" : "Comma separated list of types of exports to return, if left empty AUDIT_LOG and SNAPSHOT, and AUDIT_LOG_LEGACY exports are returned", "required" : false, "type" : "string" }, { "name" : "userId", "in" : "query", "description" : "Retrieve exports initiated by the given user", "required" : false, "type" : "string", "format" : "uuid" }, { "name" : "pageSize", "in" : "query", "description" : "Number of Exports to return, maximum is 100", "required" : false, "type" : "integer", "default" : 40, "format" : "int32" }, { "name" : "cursor", "in" : "query", "description" : "Marks the position of the first element that should be returned", "required" : false, "type" : "string" }, { "name" : "sorting", "in" : "query", "description" : "the field to sort the results by", "required" : false, "type" : "string", "default" : "createdAt" }, { "name" : "sortDirection", "in" : "query", "description" : "the direction of the sorting", "required" : false, "type" : "string", "default" : "ASC", "enum" : [ "ASC", "DESC" ] } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ExportListResponse" } } } } }, "/exports/downloads/{workspaceId}" : { "get" : { "tags" : [ "exports" ], "summary" : "downloadExportFile", "description" : "Returns the download file for the given ID", "operationId" : "downloadExportFile", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "workspaceId", "in" : "path", "description" : "the ID of the workspace to retrieve the download for", "required" : true, "type" : "string" }, { "name" : "key", "in" : "query", "description" : "a one time use key identifying the download to retrieve", "required" : true, "type" : "string" } ], "responses" : { "default" : { "description" : "successful operation" } } } }, "/exports/excel" : { "post" : { "tags" : [ "exports" ], "summary" : "createExportFile", "description" : "Creates an excel export file by using the given graphQL query and table configuration", "operationId" : "createExportFile", "consumes" : [ "text/plain" ], "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JobResponse" } } } } }, "/exports/fullExport" : { "post" : { "tags" : [ "exports" ], "summary" : "createFullExport", "description" : "Creates a full export of the workspace data, or an export of the changelog, depending on given type", "operationId" : "createFullExport", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "exportType", "in" : "query", "description" : "The type of the export, must be either SNAPSHOT, AUDIT_LOG or AUDIT_LOG_LEGACY", "required" : false, "type" : "string", "enum" : [ "AUDIT_LOG", "SNAPSHOT", "INVENTORY_IMPORT", "INVENTORY_EXPORT", "WS_SYNC", "REPORT_SYNC", "AUDIT_LOG_LEGACY" ] }, { "name" : "startDate", "in" : "query", "description" : "The start date of the audit log export in ISO-8601 format.", "required" : false, "type" : "string" }, { "name" : "endDate", "in" : "query", "description" : "The end date of the audit log export in ISO-8601 format. If left empty today is assumed", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/JobResponse" } } } } }, "/factSheets" : { "get" : { "tags" : [ "factSheets" ], "summary" : "getFactSheets", "description" : "Retrieves all Fact Sheets", "operationId" : "getFactSheets", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "type", "in" : "query", "description" : "Only list Fact Sheets with this type", "required" : false, "type" : "string" }, { "name" : "relationTypes", "in" : "query", "description" : "Comma separated list of relation types to show on the Fact Sheets", "required" : false, "type" : "string" }, { "name" : "pageSize", "in" : "query", "description" : "Number of Fact Sheets to return, maximum is 100", "required" : false, "type" : "integer", "default" : 40, "format" : "int32" }, { "name" : "cursor", "in" : "query", "description" : "Marks the position of the first element that should be returned", "required" : false, "type" : "string" }, { "name" : "permissions", "in" : "query", "description" : "Show a permission field for the Fact Sheet", "required" : false, "type" : "boolean", "default" : false } ], "responses" : { "200" : { "description" : "Read successful", "schema" : { "$ref" : "#/definitions/FactSheetListResponse" } }, "401" : { "description" : "No authorization given" } }, "security" : [ { "token" : [ ] } ] }, "post" : { "tags" : [ "factSheets" ], "summary" : "createFactSheet", "description" : "Creates a Fact Sheet", "operationId" : "createFactSheet", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Fact Sheet to add", "required" : true, "schema" : { "$ref" : "#/definitions/FactSheet" } } ], "responses" : { "200" : { "description" : "Creation successful", "schema" : { "$ref" : "#/definitions/FactSheetResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to create Fact Sheet" }, "422" : { "description" : "Invalid Fact Sheet given" } }, "security" : [ { "token" : [ ] } ] } }, "/factSheets/{id}" : { "get" : { "tags" : [ "factSheets" ], "summary" : "getFactSheet", "description" : "Retrieves a Fact Sheet", "operationId" : "getFactSheet", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string" }, { "name" : "relationTypes", "in" : "query", "description" : "Comma separated list of relation types to show on the Fact Sheets", "required" : false, "type" : "string" }, { "name" : "permissions", "in" : "query", "description" : "Show a permission field for the Fact Sheet", "required" : false, "type" : "boolean", "default" : false } ], "responses" : { "200" : { "description" : "Read successful", "schema" : { "$ref" : "#/definitions/FactSheetResponse" } }, "401" : { "description" : "No authorization given" }, "404" : { "description" : "Fact Sheet not found" } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "factSheets" ], "summary" : "updateFactSheet", "description" : "Updates a Fact Sheet", "operationId" : "updateFactSheet", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "name" : "relationTypes", "in" : "query", "description" : "Comma separated list of relation types to update. If no types are set, the relations will not be changed.", "required" : false, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Fact Sheet to update", "required" : true, "schema" : { "$ref" : "#/definitions/FactSheet" } } ], "responses" : { "200" : { "description" : "Update successful", "schema" : { "$ref" : "#/definitions/FactSheetResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to update Fact Sheet" }, "404" : { "description" : "Invalid ID supplied" }, "422" : { "description" : "Invalid Fact Sheet given" } }, "security" : [ { "token" : [ ] } ] }, "delete" : { "tags" : [ "factSheets" ], "summary" : "deleteFactSheet", "description" : "Deletes a Fact Sheet", "operationId" : "archiveFactSheet", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "Contains the comment and the Fact Sheet revision", "required" : false, "schema" : { "$ref" : "#/definitions/FactSheetArchiveParameter" } } ], "responses" : { "204" : { "description" : "Deletion successful" }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to delete Fact Sheet" }, "404" : { "description" : "Invalid ID supplied" } }, "security" : [ { "token" : [ ] } ] } }, "/factSheets/{id}/relations" : { "get" : { "tags" : [ "factSheets" ], "summary" : "getFactSheetRelations", "description" : "Retrieves all relations of a Fact Sheet, with the given type", "operationId" : "getFactSheetRelations", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string" }, { "name" : "type", "in" : "query", "description" : "Only return relations of this type", "required" : false, "type" : "string" }, { "name" : "withFactSheets", "in" : "query", "description" : "Include the to Fact Sheet in the relation", "required" : false, "type" : "boolean" } ], "responses" : { "200" : { "description" : "Read successful", "schema" : { "$ref" : "#/definitions/RelationListResponse" } }, "401" : { "description" : "No authorization given" } }, "security" : [ { "token" : [ ] } ] }, "post" : { "tags" : [ "factSheets" ], "summary" : "createFactSheetRelation", "description" : "Creates the given relation with the Fact Sheet as one side of the relation. When adding constraining relations only the ID of these relations will be used.", "operationId" : "createFactSheetRelation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "relation", "required" : true, "schema" : { "$ref" : "#/definitions/FactSheetRelation" } }, { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "Creation successful", "schema" : { "$ref" : "#/definitions/RelationResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to create relation" }, "422" : { "description" : "Invalid relation given" } }, "security" : [ { "token" : [ ] } ] } }, "/factSheets/{id}/relations/{relationId}" : { "put" : { "tags" : [ "factSheets" ], "summary" : "updateFactSheetRelation", "description" : "Updates the given relation.", "operationId" : "updateFactSheetRelation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "name" : "relationId", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "in" : "body", "name" : "relation", "required" : true, "schema" : { "$ref" : "#/definitions/FactSheetRelation" } } ], "responses" : { "200" : { "description" : "Update successful", "schema" : { "$ref" : "#/definitions/RelationResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to update relation" }, "404" : { "description" : "Invalid ID supplied" }, "422" : { "description" : "Invalid relation given" } }, "security" : [ { "token" : [ ] } ] }, "delete" : { "tags" : [ "factSheets" ], "summary" : "deleteFactSheetRelation", "description" : "Deletes the given relation.", "operationId" : "deleteFactSheetRelation", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "name" : "relationId", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "204" : { "description" : "Deletion successful" }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to delete relation" }, "404" : { "description" : "Invalid ID supplied" } }, "security" : [ { "token" : [ ] } ] } }, "/features" : { "get" : { "tags" : [ "features" ], "summary" : "getFeatures", "description" : "Retrieves features for a workspace", "operationId" : "getFeatures", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/FeatureListResponse" } } }, "security" : [ { "token" : [ ] } ] } }, "/graphql" : { "post" : { "tags" : [ "graphql" ], "summary" : "processGraphQL", "description" : "Processes GraphQL requests", "operationId" : "processGraphQL", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "request", "required" : true, "schema" : { "$ref" : "#/definitions/GraphQLRequest" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/GraphQLResult" } } }, "security" : [ { "token" : [ ] } ] } }, "/graphql/upload" : { "post" : { "tags" : [ "graphql" ], "summary" : "processGraphQLMultipart", "description" : "Processes GraphQL requests, supporting multipart documents", "operationId" : "processGraphQLMultipart", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "graphQLRequest", "in" : "formData", "required" : true, "type" : "string" }, { "name" : "file", "in" : "formData", "required" : true, "type" : "file" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/GraphQLResult" } } }, "security" : [ { "token" : [ ] } ] } }, "/models/accessControlEntities" : { "get" : { "tags" : [ "models" ], "summary" : "getAccessControlEntities", "description" : "Retrieves all access control entities", "operationId" : "getAccessControlEntities", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "pageSize", "in" : "query", "description" : "Number of reports to be returned, maximum is 100", "required" : false, "type" : "integer", "default" : 40, "format" : "int32" }, { "name" : "cursor", "in" : "query", "description" : "Marks the position of the first element that should be returned", "required" : false, "type" : "string" }, { "name" : "sorting", "in" : "query", "description" : "The field to sort the results by", "required" : false, "type" : "string", "default" : "name" }, { "name" : "sortDirection", "in" : "query", "description" : "The direction of the sorting", "required" : false, "type" : "string", "default" : "ASC", "enum" : [ "ASC", "DESC" ] } ], "responses" : { "200" : { "description" : "List successfully loaded", "schema" : { "$ref" : "#/definitions/AccessControlEntityListResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to get access control entities" } }, "security" : [ { "token" : [ ] } ] }, "post" : { "tags" : [ "models" ], "summary" : "createAccessControlEntity", "description" : "Creates an access control entity", "operationId" : "createAccessControlEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "New access control entity", "required" : false, "schema" : { "$ref" : "#/definitions/AccessControlEntity" } } ], "responses" : { "200" : { "description" : "Creation successful", "schema" : { "$ref" : "#/definitions/AccessControlEntityResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to add access control entity" } }, "security" : [ { "token" : [ ] } ] } }, "/models/accessControlEntities/{id}" : { "get" : { "tags" : [ "models" ], "summary" : "getAccessControlEntity", "description" : "Reads an access control entity", "operationId" : "readAccessControlEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "Read successful", "schema" : { "$ref" : "#/definitions/AccessControlEntityResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to read access control entity" }, "404" : { "description" : "No access control entity found with the ID supplied" } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "models" ], "summary" : "updateAccessControlEntity", "description" : "Updates an access control entity", "operationId" : "updateAccessControlEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "in" : "body", "name" : "accessControlEntity", "required" : false, "schema" : { "$ref" : "#/definitions/AccessControlEntity" } } ], "responses" : { "200" : { "description" : "Update successful", "schema" : { "$ref" : "#/definitions/AccessControlEntityResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to update access control entity" }, "404" : { "description" : "No access control entity found with the ID supplied" } }, "security" : [ { "token" : [ ] } ] }, "delete" : { "tags" : [ "models" ], "summary" : "deleteAccessControlEntity", "description" : "Deletes an access control entity", "operationId" : "deleteAccessControlEntity", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "204" : { "description" : "Deletion successful" }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to delete access control entity" }, "404" : { "description" : "No access control entity found with the ID supplied" } }, "security" : [ { "token" : [ ] } ] } }, "/models/authorization" : { "get" : { "tags" : [ "models" ], "summary" : "getAuthorization", "description" : "Provides all authorization roles were for each role a set of permission is defined.", "operationId" : "getAuthorization", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "Get successful", "schema" : { "$ref" : "#/definitions/AuthorizationRolesResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to get authorization" } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "models" ], "summary" : "updateAuthorization", "description" : "Updates all authorization roles for a given workspace. This means all existing roles and its permissions will be overriden", "operationId" : "updateAuthorization", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "The authorization configuration for the workspace which contains all roles and its permissions", "required" : true, "schema" : { "type" : "array", "items" : { "$ref" : "#/definitions/AuthorizationRole" } } }, { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "204" : { "description" : "Update successful", "schema" : { "$ref" : "#/definitions/Response" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to update authorization" }, "422" : { "description" : "Invalid authorization definition given" } }, "security" : [ { "token" : [ ] } ] } }, "/models/dataModel" : { "get" : { "tags" : [ "models" ], "summary" : "getDataModel", "description" : "Retrieves the model for a workspace", "operationId" : "getDataModel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/DataModelDefinitionResponse" } } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "models" ], "summary" : "updateDataModel", "description" : "Updates the data model for a workspace", "operationId" : "updateDataModel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "the data model for the workspace", "required" : true, "schema" : { "$ref" : "#/definitions/DataModel" } }, { "name" : "force", "in" : "query", "description" : "whether changes should be forced", "required" : false, "type" : "boolean", "default" : false }, { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/DataModelUpdateResponse" } } }, "security" : [ { "token" : [ ] } ] } }, "/models/dataModel/enriched" : { "get" : { "tags" : [ "models" ], "summary" : "getEnrichedDataModel", "description" : "Retrieves the model for a workspace, including redundant data that makes life easy for the web front end", "operationId" : "getEnrichedDataModel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/DataModelDefinitionResponse" } } }, "security" : [ { "token" : [ ] } ] } }, "/models/languages/{id}" : { "get" : { "tags" : [ "models" ], "summary" : "getLanguage", "description" : "Get the given language", "operationId" : "getLanguage", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string" }, { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "Get successful", "schema" : { "$ref" : "#/definitions/LanguageResponse" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to read language definition" }, "404" : { "description" : "No permission to read language definition" } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "models" ], "summary" : "updateLanguage", "description" : "Updates the given language", "operationId" : "updateLanguage", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "definition", "required" : true, "schema" : { "$ref" : "#/definitions/Translation" } }, { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "204" : { "description" : "Update successful", "schema" : { "$ref" : "#/definitions/Response" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to update language definition" }, "422" : { "description" : "Invalid language definition given" } }, "security" : [ { "token" : [ ] } ] } }, "/models/reportingModel" : { "get" : { "tags" : [ "models" ], "summary" : "getReportingModel", "description" : "Retrieves the report model for a workspace", "operationId" : "getReportingModel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ReportingModelResponse" } } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "models" ], "summary" : "updateReportingModel", "description" : "Updates the report model for a workspace", "operationId" : "updateReportingModel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "the report model for the workspace", "required" : true, "schema" : { "$ref" : "#/definitions/ReportingModelDefinition" } }, { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "204" : { "description" : "Update successful" } }, "security" : [ { "token" : [ ] } ] } }, "/models/viewModel" : { "get" : { "tags" : [ "models" ], "summary" : "getViewModel", "description" : "Retrieves the view model for a workspace", "operationId" : "getViewModel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/ViewModelResponse" } } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "models" ], "summary" : "updateViewModel", "description" : "Updates the view model for a workspace", "operationId" : "updateViewModel", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "the view model for the workspace", "required" : true, "schema" : { "$ref" : "#/definitions/ViewModelDefinition" } }, { "name" : "workspaceId", "in" : "query", "required" : false, "type" : "string" } ], "responses" : { "204" : { "description" : "Update successful" } }, "security" : [ { "token" : [ ] } ] } }, "/settings" : { "get" : { "tags" : [ "settings" ], "summary" : "getSettings", "description" : "", "operationId" : "getSettings", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/SettingsResponse" } } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "settings" ], "summary" : "updateSettings", "description" : "", "operationId" : "updateSettings", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "the settings for the workspace", "required" : true, "schema" : { "$ref" : "#/definitions/WorkspaceSettings" } } ], "responses" : { "204" : { "description" : "Update successful", "schema" : { "$ref" : "#/definitions/Response" } }, "401" : { "description" : "No authorization given" }, "403" : { "description" : "No permission to update settings" }, "422" : { "description" : "Invalid settings given" } }, "security" : [ { "token" : [ ] } ] } }, "/settings/factSheets/{factSheetType}" : { "get" : { "tags" : [ "settings" ], "summary" : "getFactSheetSettings", "description" : "", "operationId" : "getModelCustomization", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "factSheetType", "in" : "path", "required" : true, "type" : "string" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/FactSheetSettingsResponse" } } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "settings" ], "summary" : "putFactSheetSettings", "description" : "", "operationId" : "updateModelsWithCustomization", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "factSheetType", "in" : "path", "required" : true, "type" : "string" }, { "in" : "body", "name" : "body", "description" : "customization", "required" : true, "schema" : { "$ref" : "#/definitions/FactSheetSettings" } } ], "responses" : { "default" : { "description" : "successful operation" } }, "security" : [ { "token" : [ ] } ] } }, "/suggestions" : { "get" : { "tags" : [ "suggestions" ], "summary" : "getSuggestions", "description" : "Retrieves a list of suggestions for a search term", "operationId" : "getSuggestions", "produces" : [ "application/json" ], "parameters" : [ { "name" : "q", "in" : "query", "description" : "search term", "required" : true, "type" : "string", "maxItems" : 1000, "minItems" : 2 }, { "name" : "object", "in" : "query", "description" : "suggestions object type", "required" : false, "type" : "string", "default" : "factSheet" }, { "name" : "count", "in" : "query", "description" : "number of suggestions, defaultValue is 50 if perType = false, 25 otherwise", "required" : false, "type" : "integer", "format" : "int32" }, { "name" : "perType", "in" : "query", "description" : "if suggestions are to be grouped per object type", "required" : false, "type" : "boolean", "default" : false } ], "responses" : { "200" : { "description" : "Successful suggestion retrieval", "schema" : { "$ref" : "#/definitions/SuggestionsResponse" } }, "400" : { "description" : "Invalid query parameter value" }, "401" : { "description" : "No authorization provided" }, "403" : { "description" : "No permission to retrieve suggestions" } }, "security" : [ { "token" : [ ] } ] } }, "/todos" : { "get" : { "tags" : [ "todos" ], "summary" : "getTodos", "description" : "Retrieves all todos a user can read.", "operationId" : "getTodos", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "type", "in" : "query", "description" : "Specifies the todo type", "required" : false, "type" : "string" }, { "name" : "status", "in" : "query", "description" : "Specifies the todo status", "required" : false, "type" : "string", "enum" : [ "OPEN", "DISMISSED", "DONE" ] }, { "name" : "factSheetId", "in" : "query", "description" : "Specifies the ID of the Fact Sheet the todo is connected to - only works with manual Todos", "required" : false, "type" : "string", "format" : "uuid" }, { "name" : "userId", "in" : "query", "description" : "Specify the user Id for the user to look for", "required" : false, "type" : "string", "format" : "uuid" }, { "name" : "workspaceId", "in" : "query", "description" : "Id of the workspace to get the TodoItems from.", "required" : false, "type" : "string", "format" : "uuid" }, { "name" : "getArchived", "in" : "query", "description" : "If set to true, then todos associated with archived factsheets are retrieved as well", "required" : false, "type" : "boolean", "default" : false }, { "name" : "size", "in" : "query", "description" : "Specifies the number of Todos to get,", "required" : false, "type" : "integer", "default" : 10, "format" : "int32" }, { "name" : "page", "in" : "query", "description" : "Specifies the page of Todos to get,", "required" : false, "type" : "integer", "default" : 1, "format" : "int32" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/TodoListResponse" } } }, "security" : [ { "token" : [ ] } ] }, "post" : { "tags" : [ "todos" ], "summary" : "createTodo", "description" : "Saves a todo in the database", "operationId" : "createTodo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "in" : "body", "name" : "body", "description" : "Creates a new Todo item", "required" : false, "schema" : { "$ref" : "#/definitions/TodoData" } }, { "name" : "workspaceId", "in" : "query", "description" : "ID of the Workspace that the Todo shall be created in.", "required" : false, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/TodoResponse" } } }, "security" : [ { "token" : [ ] } ] } }, "/todos/{id}" : { "get" : { "tags" : [ "todos" ], "summary" : "getTodo", "description" : "Retrieves a todo by ID", "operationId" : "getTodo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/TodoResponse" } }, "403" : { "description" : "Permission denied" }, "404" : { "description" : "Todo not found" } }, "security" : [ { "token" : [ ] } ] }, "put" : { "tags" : [ "todos" ], "summary" : "updateTodo", "description" : "Updates a todo stored in the database.", "operationId" : "updateTodo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "workspaceId", "in" : "query", "description" : "ID of the Workspace that the Todo shall be updated in in case that the user is not assigned to one workspace", "required" : false, "type" : "string", "format" : "uuid" }, { "name" : "id", "in" : "path", "required" : true, "type" : "string", "format" : "uuid" }, { "in" : "body", "name" : "body", "description" : "todo", "required" : false, "schema" : { "$ref" : "#/definitions/TodoData" } } ], "responses" : { "200" : { "description" : "successful operation", "schema" : { "$ref" : "#/definitions/TodoResponse" } }, "400" : { "description" : "Todo item inconsistent" }, "403" : { "description" : "Permission denied" }, "404" : { "description" : "Todo not found" } }, "security" : [ { "token" : [ ] } ] }, "delete" : { "tags" : [ "todos" ], "summary" : "deleteTodo", "description" : "deletes a todo item based on provided id.", "operationId" : "deleteTodo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "id", "in" : "path", "description" : "the id of the todo item", "required" : true, "type" : "string", "format" : "uuid" }, { "name" : "workspaceId", "in" : "query", "description" : "the workspaceId in case that the SYSTEM deletes the todo", "required" : false, "type" : "string", "format" : "uuid" } ], "responses" : { "204" : { "description" : "Deletion successful" }, "403" : { "description" : "No permission to delete todo item" }, "404" : { "description" : "Invalid ID provided" }, "500" : { "description" : "Deletion successful" } }, "security" : [ { "token" : [ ] } ] } } }, "securityDefinitions" : { "token" : { "type" : "oauth2", "authorizationUrl" : "depends", "flow" : "implicit" } }, "definitions" : { "AccessControlEntity" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string", "minLength" : 0, "maxLength" : 2000 }, "displayName" : { "type" : "string", "minLength" : 0, "maxLength" : 2000 }, "description" : { "type" : "string", "minLength" : 0, "maxLength" : 2000 } } }, "AccessControlEntityListResponse" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/AccessControlEntity" } }, "total" : { "type" : "integer", "format" : "int32" }, "endCursor" : { "type" : "string", "readOnly" : true }, "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } } } }, "AccessControlEntityReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true } } }, "AccessControlEntityResponse" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/AccessControlEntity" }, "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } } } }, "Account" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "AggregatedDataType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "paths" : { "type" : "array", "items" : { "$ref" : "#/definitions/AggregationPath" } }, "function" : { "type" : "string", "enum" : [ "SUM", "AVG", "MIN", "MAX", "COUNT", "ITC_CRITICAL_COUNT", "ITC_ABS_COUNT", "ITC_CRITICAL_RATIO" ] } } } ] }, "AggregationPath" : { "type" : "object", "properties" : { "path" : { "type" : "string" } } }, "ApiError" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "messages" : { "type" : "array", "items" : { "type" : "string" } } } }, "AuthorizationRole" : { "type" : "object", "properties" : { "permissions" : { "type" : "array", "readOnly" : true, "uniqueItems" : true, "items" : { "type" : "string" } }, "name" : { "type" : "string" } } }, "AuthorizationRolesResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/AuthorizationRole" } } } }, "Bookmark" : { "type" : "object", "required" : [ "name", "readonly", "sharing", "state", "type", "userId" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "userId" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "INVENTORY", "REPORTING", "VISUALIZER", "DASHBOARD", "INVENTORY_EXPORT" ] }, "groupKey" : { "type" : "string" }, "state" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "workingCopy" : { "$ref" : "#/definitions/BookmarkWorkingCopy" }, "description" : { "type" : "string" }, "sharing" : { "type" : "string", "enum" : [ "PRIVATE", "PUBLISHED", "SHARED", "SYSTEM" ] }, "createdAt" : { "type" : "string", "format" : "date-time" }, "updatedAt" : { "type" : "string", "format" : "date-time" }, "i18nKey" : { "type" : "string" }, "predefined" : { "type" : "boolean", "default" : false }, "readonly" : { "type" : "boolean", "default" : false }, "user" : { "readOnly" : true, "$ref" : "#/definitions/User" } } }, "BookmarkListResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Bookmark" } }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int32" } } }, "BookmarkResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "$ref" : "#/definitions/Bookmark" }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } } } }, "BookmarkWorkingCopy" : { "type" : "object", "required" : [ "state", "userId" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "userId" : { "type" : "string", "format" : "uuid" }, "state" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "updatedAt" : { "type" : "string", "format" : "date-time" }, "user" : { "readOnly" : true, "$ref" : "#/definitions/User" } } }, "Chart" : { "type" : "object", "properties" : { "title" : { "type" : "string" }, "chartProduct" : { "type" : "string" }, "config" : { "$ref" : "#/definitions/ChartConfig" }, "forReporting" : { "type" : "boolean", "default" : false }, "isStacked" : { "type" : "boolean", "default" : false } } }, "ChartConfig" : { "type" : "object", "properties" : { "timespan" : { "type" : "string" }, "titleYAxis" : { "type" : "string" }, "chartType" : { "type" : "string" } } }, "ChartSetting" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "chart" : { "$ref" : "#/definitions/Chart" }, "series" : { "type" : "array", "items" : { "$ref" : "#/definitions/Series" } } } }, "CommentReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "messageHash" : { "type" : "integer", "format" : "int32" }, "userId" : { "type" : "string", "format" : "uuid" }, "createdAt" : { "type" : "string", "format" : "date-time" } } }, "Completion" : { "type" : "object", "discriminator" : "type", "properties" : { "type" : { "type" : "string", "readOnly" : true }, "completion" : { "type" : "number", "format" : "double", "readOnly" : true }, "percentage" : { "type" : "integer", "format" : "int32", "readOnly" : true }, "subCompletions" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/Completion" } } } }, "ComponentConfig" : { "type" : "object", "properties" : { "relation" : { "type" : "string" }, "field" : { "type" : "string" }, "fixed" : { "type" : "string" }, "separator" : { "type" : "string" }, "prefix" : { "type" : "string" }, "postfix" : { "type" : "string" }, "operation" : { "type" : "string", "enum" : [ "APPEND", "PREPEND" ] } } }, "ConcreteCompletion" : { "allOf" : [ { "$ref" : "#/definitions/Completion" }, { "type" : "object", "properties" : { "type" : { "type" : "string", "readOnly" : true }, "completion" : { "type" : "number", "format" : "double", "readOnly" : true }, "percentage" : { "type" : "integer", "format" : "int32", "readOnly" : true } } } ] }, "Config" : { "type" : "object", "properties" : { "fullName" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/definitions/ComponentConfig" } }, "displayName" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/definitions/ComponentConfig" } } } }, "ConfigTypeOnOffWithTime" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "readOnly" : true, "default" : false }, "value" : { "type" : "integer", "format" : "int64" }, "unit" : { "type" : "string", "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "CustomTranslation" : { "type" : "object", "properties" : { "welcomeMessage" : { "type" : "string" }, "help" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "CustomValidator" : { "type" : "object", "discriminator" : "type", "properties" : { "type" : { "type" : "string", "readOnly" : true }, "value" : { "type" : "string", "readOnly" : true } } }, "CustomizationConfig" : { "type" : "object", "properties" : { "maxHierarchyLevel" : { "type" : "integer", "format" : "int32" }, "qualitySeal" : { "$ref" : "#/definitions/CustomizationQualitySeal" }, "defaultACL" : { "type" : "string", "enum" : [ "GLOBAL", "WRITE_RESTRICTED", "READ_RESTRICTED" ] } } }, "CustomizationLocalisedLabel" : { "type" : "object", "properties" : { "singular" : { "type" : "string" }, "plural" : { "type" : "string" } } }, "CustomizationQualitySeal" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "value" : { "type" : "integer", "format" : "int64" }, "unit" : { "type" : "string", "enum" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ] } } }, "CustomizationSection" : { "type" : "object", "properties" : { "subsections" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/CustomizationSubsection" } } } }, "CustomizationSubsection" : { "type" : "object", "properties" : { "weight" : { "type" : "number", "format" : "double" }, "disabled" : { "type" : "boolean", "default" : false } } }, "Dashboard" : { "type" : "object", "properties" : { "criteria" : { "type" : "string" } } }, "DashboardModelTranslation" : { "type" : "object", "properties" : { "shortcuts" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "panels" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "DataModel" : { "type" : "object", "properties" : { "factSheets" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/FactSheetDefinition" } }, "relations" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "$ref" : "#/definitions/RelationDefinition" } }, "validators" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "$ref" : "#/definitions/CustomValidator" } }, "externalIdFields" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "$ref" : "#/definitions/ExternalIdFieldDefinition" } }, "rules" : { "$ref" : "#/definitions/RulesDefinition" } } }, "DataModelDefinitionResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "$ref" : "#/definitions/DataModel" } } }, "DataModelTranslation" : { "type" : "object", "properties" : { "externalIdFields" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "factSheets" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/FactSheetTranslation" } }, "relations" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/RelationTranslation" } } } }, "DataModelUpdateResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Deletion" } }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int32" } } }, "DataType" : { "type" : "object", "discriminator" : "type", "properties" : { "mandatory" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "readOnly" : true }, "inFacet" : { "type" : "boolean", "readOnly" : true, "default" : false }, "inView" : { "type" : "boolean", "readOnly" : true, "default" : false }, "viewAggregation" : { "type" : "string", "readOnly" : true, "enum" : [ "OFF", "MIN", "MAX" ] }, "activatedBy" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "initialValue" : { "type" : "string", "readOnly" : true }, "quickSearch" : { "type" : "boolean", "readOnly" : true, "default" : false }, "fullTextSearch" : { "type" : "boolean", "readOnly" : true, "default" : false } } }, "DateValue" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "value" : { "type" : "string", "format" : "date" } } } ] }, "Deletion" : { "type" : "object", "properties" : { "deletionType" : { "type" : "string", "enum" : [ "FACT_SHEET", "RELATION", "FACT_SHEET_FIELD", "FACT_SHEET_FIELD_VALUE", "RELATION_FIELD", "RELATION_FIELD_VALUE" ] }, "count" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "info1" : { "type" : "string" }, "info2" : { "type" : "string" } } }, "Design" : { "type" : "object", "properties" : { "activeMode" : { "type" : "string", "enum" : [ "CLASSIC", "MODERN", "CUSTOM" ] }, "customCss" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "Document" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "url" : { "type" : "string" }, "origin" : { "type" : "string" }, "createdAt" : { "type" : "string", "format" : "date-time" }, "fileInformation" : { "$ref" : "#/definitions/FileInformation" } } }, "DoubleNumberDataType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false } } } ] }, "DoubleValue" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "value" : { "type" : "number", "format" : "double" } } } ] }, "Export" : { "type" : "object", "required" : [ "downloadFilename", "id", "localFilename", "status", "type", "userId" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "userId" : { "type" : "string", "format" : "uuid" }, "user" : { "$ref" : "#/definitions/User" }, "type" : { "type" : "string", "enum" : [ "AUDIT_LOG", "SNAPSHOT", "INVENTORY_IMPORT", "INVENTORY_EXPORT", "WS_SYNC", "REPORT_SYNC", "AUDIT_LOG_LEGACY" ] }, "status" : { "type" : "string", "enum" : [ "STARTED", "COMPLETED", "DOWNLOADED", "ERROR", "DELETED", "CANCELED" ] }, "localFilename" : { "type" : "string" }, "downloadFilename" : { "type" : "string" }, "createdAt" : { "type" : "string", "format" : "date-time" }, "deleteAt" : { "type" : "string", "format" : "date-time" }, "dryRun" : { "type" : "boolean", "default" : false }, "downloadKey" : { "type" : "string", "format" : "uuid" }, "factSheetTypes" : { "type" : "string" }, "factSheetCount" : { "type" : "integer", "format" : "int32" }, "columnCount" : { "type" : "integer", "format" : "int32" }, "bookmark" : { "$ref" : "#/definitions/Bookmark" } } }, "ExportListResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Export" } }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int32" }, "endCursor" : { "type" : "string" } } }, "ExternalId" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "externalId" : { "type" : "string" }, "comment" : { "type" : "string" }, "status" : { "type" : "string" }, "externalUrl" : { "type" : "string" }, "externalVersion" : { "type" : "string" }, "forceWrite" : { "type" : "boolean", "default" : false } } } ] }, "ExternalIdFieldDefinition" : { "type" : "object", "properties" : { "quickSearch" : { "type" : "boolean", "readOnly" : true, "default" : false }, "fullTextSearch" : { "type" : "boolean", "readOnly" : true, "default" : false }, "urlTemplate" : { "type" : "string", "readOnly" : true }, "uniqueFactSheet" : { "type" : "boolean", "readOnly" : true, "default" : false }, "autoIncrement" : { "type" : "boolean", "readOnly" : true, "default" : false }, "readOnly" : { "type" : "boolean", "readOnly" : true, "default" : false }, "forFactSheets" : { "type" : "array", "readOnly" : true, "uniqueItems" : true, "items" : { "type" : "string" } }, "validators" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string" } } } }, "ExternalIdType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false }, "urlTemplate" : { "type" : "string", "readOnly" : true }, "uniqueFactSheet" : { "type" : "boolean", "readOnly" : true, "default" : false }, "autoIncrement" : { "type" : "boolean", "readOnly" : true, "default" : false }, "readOnly" : { "type" : "boolean", "readOnly" : true, "default" : false }, "validators" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string" } } } } ] }, "FactSheet" : { "type" : "object", "required" : [ "name" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "fullName" : { "type" : "string" }, "type" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/definitions/Tag" } }, "fields" : { "type" : "array", "items" : { "$ref" : "#/definitions/FieldnameAndData" } }, "relations" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheetRelation" } }, "completion" : { "$ref" : "#/definitions/Completion" }, "createdAt" : { "type" : "string", "format" : "date-time" }, "updatedAt" : { "type" : "string", "format" : "date-time" }, "documents" : { "type" : "array", "items" : { "$ref" : "#/definitions/Document" } }, "approvedAt" : { "type" : "string", "format" : "date-time" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "ARCHIVED" ] }, "level" : { "type" : "integer", "format" : "int32" }, "qualitySealStatus" : { "type" : "string", "enum" : [ "DISABLED", "APPROVED", "BROKEN" ] }, "permissions" : { "$ref" : "#/definitions/PermissionsField" }, "score" : { "type" : "number", "format" : "float" }, "rev" : { "type" : "integer", "format" : "int64" }, "naFields" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "subscriptions" : { "type" : "array", "items" : { "$ref" : "#/definitions/Subscription" } }, "permittedReadACL" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AccessControlEntityReference" } }, "permittedWriteACL" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/AccessControlEntityReference" } } } }, "FactSheetArchiveParameter" : { "type" : "object", "properties" : { "comment" : { "type" : "string" }, "rev" : { "type" : "integer", "format" : "int64" } } }, "FactSheetConfiguration" : { "type" : "object", "properties" : { "qualitySeal" : { "$ref" : "#/definitions/ConfigTypeOnOffWithTime" }, "maxHierarchyLevel" : { "type" : "integer", "format" : "int32" }, "defaultACL" : { "type" : "string", "enum" : [ "GLOBAL", "WRITE_RESTRICTED", "READ_RESTRICTED" ] } } }, "FactSheetDefinition" : { "type" : "object", "properties" : { "relations" : { "type" : "array", "items" : { "type" : "string" } }, "config" : { "$ref" : "#/definitions/FactSheetConfiguration" }, "fields" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "$ref" : "#/definitions/DataType" } }, "namingRule" : { "$ref" : "#/definitions/NamingRuleDefinition" } } }, "FactSheetLabelTranslation" : { "type" : "object", "properties" : { "plural" : { "type" : "string" }, "singular" : { "type" : "string" } } }, "FactSheetListResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheet" } }, "cursor" : { "type" : "string" } } }, "FactSheetReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "type" : { "type" : "string" }, "displayName" : { "type" : "string" } } }, "FactSheetRelation" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "displayNameToFS" : { "type" : "string" }, "typeFromFS" : { "type" : "string" }, "typeToFS" : { "type" : "string" }, "permittedReadACL" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "activeFrom" : { "type" : "string", "format" : "date" }, "activeUntil" : { "type" : "string", "format" : "date" }, "constrainingRelations" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/FactSheetRelation" } }, "idsOfConstrainingRelations" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string", "format" : "uuid" } }, "fields" : { "type" : "array", "items" : { "$ref" : "#/definitions/FieldnameAndData" } }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "ARCHIVED" ] }, "fromId" : { "type" : "string", "format" : "uuid" }, "toId" : { "type" : "string", "format" : "uuid" }, "factSheet" : { "$ref" : "#/definitions/FactSheet" }, "naFields" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "type" : { "type" : "string" } } }, "FactSheetResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "$ref" : "#/definitions/FactSheet" }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } } } }, "FactSheetSettings" : { "type" : "object", "required" : [ "bgColor", "config" ], "properties" : { "bgColor" : { "type" : "string" }, "onTheFlyCreation" : { "type" : "boolean", "default" : false }, "config" : { "$ref" : "#/definitions/CustomizationConfig" }, "sections" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/CustomizationSection" } }, "labels" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/CustomizationLocalisedLabel" } } } }, "FactSheetSettingsResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "$ref" : "#/definitions/FactSheetSettings" } } }, "FactSheetTodoData" : { "allOf" : [ { "$ref" : "#/definitions/TodoData" }, { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/FactSheetTodoDataData" } } } ] }, "FactSheetTodoDataData" : { "type" : "object", "properties" : { "factSheets" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheetReference" } }, "description" : { "type" : "string" } } }, "FactSheetTranslation" : { "type" : "object", "properties" : { "fields" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "label" : { "$ref" : "#/definitions/FactSheetLabelTranslation" } } }, "FactSheetViewModel" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "bgColor" : { "type" : "string" }, "color" : { "type" : "string" }, "onTheFlyCreation" : { "type" : "boolean", "default" : false }, "fieldMetaData" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "sections" : { "type" : "array", "items" : { "$ref" : "#/definitions/Section" } }, "hoverConfig" : { "$ref" : "#/definitions/HoverConfig" } } }, "Feature" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "FUNCTIONAL", "QUOTA" ] }, "description" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "DISABLED", "ENABLED" ] }, "group" : { "type" : "string", "enum" : [ "BETA", "PRODUCTIVE", "LEGACY", "CUSTOMER", "EXCEPTION" ] }, "quota" : { "type" : "integer", "format" : "int32" }, "roles" : { "type" : "array", "items" : { "type" : "string" } }, "customized" : { "type" : "boolean", "default" : false } } }, "FeatureListResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/Feature" } }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int32" } } }, "Field" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string" } } }, "FieldLayout" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string" }, "size" : { "type" : "integer", "format" : "int32" }, "readonly" : { "type" : "boolean", "default" : false }, "profile" : { "type" : "string" }, "weight" : { "type" : "number", "format" : "double" } } }, "FieldnameAndData" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "data" : { "$ref" : "#/definitions/LxField" }, "dataType" : { "$ref" : "#/definitions/DataType" } } }, "FileInformation" : { "type" : "object", "properties" : { "fileName" : { "type" : "string" }, "mediaType" : { "type" : "string" } } }, "FromAndToDefinition" : { "type" : "object", "properties" : { "factSheetType" : { "type" : "string" }, "multiplicity" : { "type" : "string", "enum" : [ "SINGLE", "MULTI" ] }, "mandatory" : { "type" : "boolean", "default" : false }, "activatedBy" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "name" : { "type" : "string", "readOnly" : true }, "groupByTargetField" : { "type" : "string" } } }, "GraphQLRequest" : { "type" : "object", "properties" : { "query" : { "type" : "string" }, "variables" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "type" : "object" } }, "operationName" : { "type" : "string", "readOnly" : true } } }, "GraphQLResult" : { "type" : "object", "properties" : { "data" : { "type" : "object" }, "errors" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } }, "HelpSettings" : { "type" : "object", "properties" : { "helpCenter" : { "type" : "string" }, "userGuide" : { "type" : "string" }, "supportEmail" : { "type" : "string" }, "supportUrl" : { "type" : "string" }, "showHelpTours" : { "type" : "boolean", "default" : false } } }, "HelpTextAndLabelTranslation" : { "type" : "object", "properties" : { "helpText" : { "type" : "string" }, "label" : { "type" : "string" } } }, "HoverConfig" : { "type" : "object", "properties" : { "fields" : { "type" : "array", "items" : { "$ref" : "#/definitions/Field" } } } }, "InactiveUserTodoData" : { "allOf" : [ { "$ref" : "#/definitions/TodoData" }, { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/InactiveUserTodoDataData" } } } ] }, "InactiveUserTodoDataData" : { "type" : "object", "properties" : { "user" : { "$ref" : "#/definitions/UserReference" } } }, "IntNumberDataType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false } } } ] }, "IntegerValue" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "value" : { "type" : "integer", "format" : "int32" } } } ] }, "IntegrationsSettings" : { "type" : "object", "properties" : { "technopedia" : { "$ref" : "#/definitions/UserNameAndPasswordIntegrationSettings" }, "signavio" : { "$ref" : "#/definitions/SignavioSettings" }, "intercom" : { "$ref" : "#/definitions/IntercomSettings" } } }, "IntercomSettings" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "default" : false }, "appId" : { "type" : "string" }, "identitySecret" : { "type" : "string" } } }, "JobResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "$ref" : "#/definitions/JobResponseData" }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } } } }, "JobResponseData" : { "type" : "object", "properties" : { "jobId" : { "type" : "string" }, "synclogId" : { "type" : "string" }, "message" : { "type" : "string" } } }, "LanguageResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "Layout" : { "type" : "object", "properties" : { "fields" : { "type" : "array", "items" : { "$ref" : "#/definitions/FieldLayout" } } } }, "Lifecycle" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "phases" : { "type" : "array", "items" : { "$ref" : "#/definitions/Phase" } } } } ] }, "LifecycleType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false }, "values" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string" } } } } ] }, "LinkedSubscriptionRoleData" : { "type" : "object", "properties" : { "roleId" : { "type" : "string", "format" : "uuid" }, "comment" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" } } }, "Location" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "placeId" : { "type" : "string" }, "rawAddress" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" }, "geoCity" : { "type" : "string" }, "geoCountryCode" : { "type" : "string" }, "geoCountry" : { "type" : "string" }, "geoAddress" : { "type" : "string" }, "geoStreet" : { "type" : "string" }, "geoHouseNumber" : { "type" : "string" }, "geoPostalCode" : { "type" : "string" } } } ] }, "LocationType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false } } } ] }, "LxField" : { "type" : "object", "required" : [ "type" ], "discriminator" : "type", "properties" : { "type" : { "type" : "string", "enum" : [ "StringValue", "IntegerValue", "DoubleValue", "DateValue", "SingleSelect", "Classification", "Location", "Lifecycle", "ExternalId", "MultipleSelect", "ProjectStatusProgress" ] } } }, "Metrics" : { "type" : "object", "properties" : { "charts" : { "type" : "array", "items" : { "$ref" : "#/definitions/ChartSetting" } } } }, "MultipleSelect" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "values" : { "type" : "array", "items" : { "type" : "string" } } } } ] }, "MultipleSelectType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false }, "values" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string" } } } } ] }, "NamingRuleDefinition" : { "type" : "object", "properties" : { "regular" : { "readOnly" : true, "$ref" : "#/definitions/Config" }, "autogenerate" : { "readOnly" : true, "$ref" : "#/definitions/Config" } } }, "OpenCommentTodoData" : { "allOf" : [ { "$ref" : "#/definitions/TodoData" }, { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/OpenCommentTodoDataData" } } } ] }, "OpenCommentTodoDataData" : { "type" : "object", "properties" : { "factSheets" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheetReference" } }, "comments" : { "type" : "array", "items" : { "$ref" : "#/definitions/CommentReference" } }, "user" : { "$ref" : "#/definitions/UserReference" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "CLOSED", "REOPENED" ] }, "subscriptionType" : { "type" : "string" } } }, "Permission" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "workspaceId" : { "type" : "string" }, "role" : { "type" : "string" }, "status" : { "type" : "string" } } }, "PermissionsField" : { "type" : "object", "properties" : { "self" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string", "enum" : [ "READ", "UPDATE", "CREATE", "DELETE", "ARCHIVE", "IMPORT", "EXPORT", "INLINE_EDIT", "UNLOCK" ] } }, "create" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "read" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "update" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "delete" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "Phase" : { "type" : "object", "properties" : { "startDate" : { "type" : "string", "format" : "date" }, "phase" : { "type" : "string" } } }, "PollReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "title" : { "type" : "string" } } }, "PollRunReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" } } }, "Position" : { "type" : "object", "properties" : { "offset" : { "type" : "integer", "format" : "int32" }, "length" : { "type" : "integer", "format" : "int32" } } }, "ProjectStatus" : { "type" : "object", "properties" : { "date" : { "type" : "string", "format" : "date" }, "status" : { "type" : "string" }, "progress" : { "type" : "integer", "format" : "int32" }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "projectStatusProviderInfos" : { "type" : "array", "items" : { "$ref" : "#/definitions/ProjectStatusProviderInfo" } } } }, "ProjectStatusProgress" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "projectStatus" : { "type" : "array", "items" : { "$ref" : "#/definitions/ProjectStatus" } } } } ] }, "ProjectStatusProviderInfo" : { "type" : "object", "properties" : { "providerId" : { "type" : "string", "format" : "uuid" }, "actualsOpEx" : { "type" : "integer", "format" : "int32" }, "actualsCapEx" : { "type" : "integer", "format" : "int32" }, "etcOpEx" : { "type" : "integer", "format" : "int32" }, "etcCapEx" : { "type" : "integer", "format" : "int32" } } }, "ProjectStatusType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false }, "values" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string" } } } } ] }, "Reason" : { "type" : "object", "properties" : { "field" : { "type" : "string" }, "value" : { "type" : "string" }, "positions" : { "type" : "array", "items" : { "$ref" : "#/definitions/Position" } } } }, "RegexValidator" : { "allOf" : [ { "$ref" : "#/definitions/CustomValidator" }, { "type" : "object", "properties" : { "type" : { "type" : "string" } } } ] }, "RelationDefinition" : { "type" : "object", "properties" : { "from" : { "readOnly" : true, "$ref" : "#/definitions/FromAndToDefinition" }, "to" : { "readOnly" : true, "$ref" : "#/definitions/FromAndToDefinition" }, "fields" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "$ref" : "#/definitions/DataType" } }, "constrainingRelations" : { "type" : "array", "readOnly" : true, "uniqueItems" : true, "items" : { "type" : "string" } }, "constraints" : { "type" : "array", "readOnly" : true, "uniqueItems" : true, "items" : { "type" : "string", "enum" : [ "TYPE_EQUAL", "CYCLES_ALLOWED", "FACT_SHEET_UNIQUE_LAX" ] } } } }, "RelationListResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheetRelation" } } } }, "RelationRecommendationTodoData" : { "allOf" : [ { "$ref" : "#/definitions/TodoData" }, { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/RelationRecommendationTodoDataData" } } } ] }, "RelationRecommendationTodoDataData" : { "type" : "object", "properties" : { "factSheets" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheetReference" } }, "targetFactSheet" : { "$ref" : "#/definitions/FactSheetReference" }, "score" : { "type" : "number", "format" : "double" } } }, "RelationResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "$ref" : "#/definitions/FactSheetRelation" }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } } } }, "RelationTranslation" : { "type" : "object", "properties" : { "fields" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "labels" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "ReportConfiguration" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "version" : { "type" : "string" }, "config" : { "type" : "object" } } }, "ReportMenuEntry" : { "type" : "object", "properties" : { "report" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false } } }, "ReportMenuSection" : { "type" : "object", "properties" : { "icon" : { "type" : "string" }, "entries" : { "type" : "array", "items" : { "$ref" : "#/definitions/ReportMenuEntry" } } } }, "ReportingModelDefinition" : { "type" : "object", "properties" : { "menu" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/ReportMenuSection" } }, "reports" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/ReportConfiguration" } } } }, "ReportingModelResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "$ref" : "#/definitions/ReportingModelDefinition" } } }, "ReportingModelTranslation" : { "type" : "object", "properties" : { "menu" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "reports" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "Response" : { "type" : "object", "properties" : { "metadata" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "object" } } }, "status" : { "type" : "integer", "format" : "int32" }, "entity" : { "type" : "object" } } }, "RetentionSettings" : { "type" : "object", "properties" : { "eventUserRetentionDays" : { "type" : "integer", "format" : "int64" } } }, "Rule" : { "type" : "object", "properties" : { "tagName" : { "type" : "string" }, "operator" : { "type" : "string" }, "target" : { "type" : "string" } } }, "RulesDefinition" : { "type" : "object", "properties" : { "defaultNamingRule" : { "$ref" : "#/definitions/NamingRuleDefinition" } } }, "Section" : { "type" : "object", "properties" : { "label" : { "type" : "string" }, "disabled" : { "type" : "boolean", "default" : false }, "subsections" : { "type" : "array", "items" : { "$ref" : "#/definitions/Subsection" } }, "tabs" : { "type" : "array", "items" : { "type" : "string" } }, "weight" : { "type" : "number", "format" : "double" } } }, "SectionCompletion" : { "allOf" : [ { "$ref" : "#/definitions/Completion" }, { "type" : "object" } ] }, "Series" : { "type" : "object", "properties" : { "title" : { "type" : "string" }, "measurement" : { "type" : "string" }, "fieldName" : { "type" : "string" }, "type" : { "type" : "string" }, "tagsRule" : { "$ref" : "#/definitions/TagsRule" }, "aggregationFunction" : { "type" : "string" }, "grouping" : { "type" : "string" }, "color" : { "type" : "string" } } }, "SettingsResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "$ref" : "#/definitions/WorkspaceSettings" } } }, "SignavioGlossaryCategoryMapping" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "default" : false }, "strict" : { "type" : "boolean", "default" : false }, "glossaryCategoryId" : { "type" : "string" }, "leanixRelationName" : { "type" : "string" }, "master" : { "type" : "string", "enum" : [ "LEANIX", "SIGNAVIO" ] } } }, "SignavioProcessMapping" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "default" : false }, "strict" : { "type" : "boolean", "default" : false }, "directoryIds" : { "type" : "array", "items" : { "type" : "string" } }, "factSheetType" : { "type" : "string" }, "linkProcessingMode" : { "type" : "string", "enum" : [ "NO_PROCESSING", "PARENT_CHILD" ] }, "publishedOnly" : { "type" : "boolean", "default" : false } } }, "SignavioSettings" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "default" : false }, "userName" : { "type" : "string" }, "password" : { "type" : "string" }, "signavioUrl" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "loginParams" : { "type" : "string" }, "processMapping" : { "$ref" : "#/definitions/SignavioProcessMapping" }, "glossaryCategoryMappings" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/SignavioGlossaryCategoryMapping" } } } }, "SingleSelect" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "keyword" : { "type" : "string" } } } ] }, "SingleSelectType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false }, "values" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string" } } } } ] }, "SnapshotSettings" : { "type" : "object", "properties" : { "allowOverwrite" : { "type" : "boolean", "default" : false } } }, "StringDataType" : { "allOf" : [ { "$ref" : "#/definitions/DataType" }, { "type" : "object", "properties" : { "mandatory" : { "type" : "boolean", "readOnly" : true, "default" : false }, "validators" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string" } } } } ] }, "StringValue" : { "allOf" : [ { "$ref" : "#/definitions/LxField" }, { "type" : "object", "properties" : { "value" : { "type" : "string" } } } ] }, "Subscription" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "userId" : { "type" : "string", "format" : "uuid" }, "type" : { "type" : "string", "enum" : [ "ACCOUNTABLE", "RESPONSIBLE", "OBSERVER" ] }, "linkedRoles" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/LinkedSubscriptionRoleData" } }, "roles" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/definitions/SubscriptionRoleLegacy" } } } }, "SubscriptionRoleLegacy" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "restrictToFactSheetTypes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "subscriptionType" : { "type" : "string", "enum" : [ "ACCOUNTABLE", "RESPONSIBLE", "OBSERVER" ] } } }, "SubscriptionSettings" : { "type" : "object", "properties" : { "subscriptionTypes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string", "enum" : [ "ACCOUNTABLE", "RESPONSIBLE", "OBSERVER" ] } }, "roleAssignment" : { "type" : "string", "enum" : [ "SINGLE", "MULTIPLE" ] }, "roleMode" : { "type" : "string", "enum" : [ "ON_THE_FLY", "OPTIONAL", "REQUIRED" ] } } }, "Subsection" : { "type" : "object", "properties" : { "label" : { "type" : "string" }, "helpText" : { "type" : "string" }, "template" : { "type" : "string" }, "templateOptions" : { "$ref" : "#/definitions/TemplateOptions" }, "weight" : { "type" : "number", "format" : "double" }, "disabled" : { "type" : "boolean", "default" : false } } }, "Suggestion" : { "type" : "object", "properties" : { "objectId" : { "type" : "string", "format" : "uuid" }, "displayName" : { "type" : "string" }, "type" : { "type" : "string" }, "reasons" : { "type" : "array", "items" : { "$ref" : "#/definitions/Reason" } } } }, "SuggestionsDTO" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "suggestions" : { "type" : "array", "items" : { "$ref" : "#/definitions/Suggestion" } } } }, "SuggestionsResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/SuggestionsDTO" } }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int32" } } }, "SurveyResponseData" : { "type" : "object", "properties" : { "poll" : { "$ref" : "#/definitions/PollReference" }, "pollRun" : { "$ref" : "#/definitions/PollRunReference" }, "creator" : { "$ref" : "#/definitions/UserReference" }, "factSheets" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheetReference" } } } }, "SurveyResponseTodoData" : { "allOf" : [ { "$ref" : "#/definitions/TodoData" }, { "type" : "object", "properties" : { "data" : { "$ref" : "#/definitions/SurveyResponseData" } } } ] }, "Tag" : { "type" : "object", "required" : [ "bgColor", "status" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "tagGroup" : { "$ref" : "#/definitions/TagGroup" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "bgColor" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "ARCHIVED" ] } } }, "TagGroup" : { "type" : "object", "required" : [ "mandatory", "mode" ], "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "shortName" : { "type" : "string" }, "description" : { "type" : "string" }, "mandatory" : { "type" : "boolean", "default" : false }, "mode" : { "type" : "string", "enum" : [ "SINGLE", "MULTIPLE" ] }, "restrictToFactSheetTypes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "TagSettings" : { "type" : "object", "properties" : { "taggingMode" : { "type" : "string", "enum" : [ "ON_THE_FLY", "PRE_DEFINED_ONLY", "PRE_DEFINED_OR_ON_THE_FLY" ] } } }, "TagsRule" : { "type" : "object", "properties" : { "operator" : { "type" : "string" }, "rules" : { "type" : "array", "items" : { "$ref" : "#/definitions/Rule" } } } }, "TemplateOptions" : { "type" : "object", "properties" : { "relationName" : { "type" : "string" }, "fieldName" : { "type" : "string" }, "layout" : { "$ref" : "#/definitions/Layout" } } }, "TodoData" : { "type" : "object", "required" : [ "userId" ], "discriminator" : "type", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "userId" : { "type" : "string", "format" : "uuid" }, "status" : { "type" : "string", "enum" : [ "OPEN", "DISMISSED", "DONE" ] }, "dueAt" : { "type" : "string", "format" : "date" }, "createdAt" : { "type" : "string", "format" : "date-time" }, "updatedAt" : { "type" : "string", "format" : "date-time" }, "priority" : { "type" : "number", "format" : "double" }, "updatedBy" : { "type" : "string", "format" : "uuid" }, "type" : { "type" : "string", "readOnly" : true } } }, "TodoListResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "type" : "array", "items" : { "$ref" : "#/definitions/TodoData" } }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int32" } } }, "TodoResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OK", "ERROR" ] }, "type" : { "type" : "string" }, "data" : { "$ref" : "#/definitions/TodoData" }, "errorMessage" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } } } }, "Translation" : { "type" : "object", "properties" : { "dataModel" : { "$ref" : "#/definitions/DataModelTranslation" }, "viewModel" : { "$ref" : "#/definitions/ViewModelTranslation" }, "reportingModel" : { "$ref" : "#/definitions/ReportingModelTranslation" }, "dashboardModel" : { "$ref" : "#/definitions/DashboardModelTranslation" }, "custom" : { "$ref" : "#/definitions/CustomTranslation" } } }, "User" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "displayName" : { "type" : "string" }, "userName" : { "type" : "string" }, "email" : { "type" : "string" } } }, "UserFromCookie" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "username" : { "type" : "string" }, "role" : { "type" : "string" }, "status" : { "type" : "string" }, "account" : { "$ref" : "#/definitions/Account" }, "permission" : { "$ref" : "#/definitions/Permission" } } }, "UserNameAndPasswordIntegrationSettings" : { "type" : "object", "properties" : { "active" : { "type" : "boolean", "default" : false }, "userName" : { "type" : "string" }, "password" : { "type" : "string" } } }, "UserReference" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "email" : { "type" : "string" }, "displayName" : { "type" : "string" }, "permissionId" : { "type" : "string", "format" : "uuid" }, "lastLogin" : { "type" : "string", "format" : "date-time" } } }, "ViewModelDefinition" : { "type" : "object", "properties" : { "factSheets" : { "type" : "array", "items" : { "$ref" : "#/definitions/FactSheetViewModel" } } } }, "ViewModelResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "type" : { "type" : "string" }, "message" : { "type" : "string" }, "errors" : { "type" : "array", "items" : { "$ref" : "#/definitions/ApiError" } }, "total" : { "type" : "integer", "format" : "int64" }, "data" : { "$ref" : "#/definitions/ViewModelDefinition" } } }, "ViewModelTranslation" : { "type" : "object", "properties" : { "section" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "subsection" : { "type" : "object", "additionalProperties" : { "$ref" : "#/definitions/HelpTextAndLabelTranslation" } } } }, "WebCallbackValidator" : { "allOf" : [ { "$ref" : "#/definitions/CustomValidator" }, { "type" : "object", "required" : [ "params" ], "properties" : { "params" : { "type" : "object", "readOnly" : true, "additionalProperties" : { "type" : "string" } }, "type" : { "type" : "string" } } } ] }, "WorkspaceSettings" : { "type" : "object", "properties" : { "subscriptions" : { "$ref" : "#/definitions/SubscriptionSettings" }, "help" : { "$ref" : "#/definitions/HelpSettings" }, "snapshot" : { "$ref" : "#/definitions/SnapshotSettings" }, "integrations" : { "$ref" : "#/definitions/IntegrationsSettings" }, "currency" : { "type" : "string" }, "language" : { "type" : "string" }, "jsSnippet" : { "type" : "string" }, "idleTimeoutMinutes" : { "type" : "integer", "format" : "int32" }, "defaultReportId" : { "type" : "string" }, "dataPrivacy" : { "type" : "string", "enum" : [ "NORMAL", "RELAXED" ] }, "quickSearchMode" : { "type" : "string", "enum" : [ "LIST_VIEW", "GROUPED_VIEW" ] }, "design" : { "$ref" : "#/definitions/Design" }, "metrics" : { "$ref" : "#/definitions/Metrics" }, "dashboards" : { "type" : "array", "items" : { "$ref" : "#/definitions/Dashboard" } }, "retention" : { "$ref" : "#/definitions/RetentionSettings" }, "tags" : { "$ref" : "#/definitions/TagSettings" } } } } }