{ "swagger": "2.0", "info": { "version": "v1", "title": "COMOS - REST API", "description": "The COMOS REST API is designed for integrating with the COMOS platform, offering a wide range of functionalities for plant engineering and lifecycle management. This API is ideal for developers and integrators looking to enhance plant design, maintenance, and operational efficiency by leveraging COMOS's extensive engineering data management capabilities." }, "paths": { "/public/api/discovery/v1/services": { "get": { "tags": [ "PublicApiDiscovery" ], "summary": "Provides discovery services for public apis", "operationId": "PublicApiDiscovery_GetDiscoveries", "consumes": [], "produces": [ "application/json", "text/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Discovery" } } } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/documents/{docid}": { "get": { "tags": [ "PublicApiDocuments" ], "summary": "Downloads a document based on document Id", "description": "The supplied document ID can refer to documents of various types:\r\n \u003Cul\u003E\u003Cli\u003Ea plain COMOS document (including reports)\u003C/li\u003E\u003Cli\u003Ea DDM (= versioned) document (in this case the latest version will be retrieved)\u003C/li\u003E\u003Cli\u003Ea particular version of a DDM (= versioned) document\u003C/li\u003E\u003Cli\u003Ea revision (in this case the parameter \"docid\" technically refers to COMOS device)\u003C/li\u003E\u003Cli\u003Ea redlining document of a revision\u003C/li\u003E\u003Cli\u003Ean additional document of a revision\u003C/li\u003E\u003C/ul\u003E", "operationId": "PublicApiDocuments_GetDocument", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "Document Id", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "export_type", "in": "query", "description": "Export type. At the moment the types 'report2pdf' and 'report2excel' are supported. Note that docid must refer to a report in this case.", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "The document was found and the export was created", "schema": { "$ref": "#/definitions/System.Object" } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false }, "patch": { "tags": [ "PublicApiDocuments" ], "summary": "Replaces an existing document under an object with a new one while keeping the UID. Only for documents without version management (non DDMS)", "description": "The uploaded document will replace the existing document identified by docid.\r\n The request should be sent as multipart/form-data with the file content.", "operationId": "PublicApiDocuments_ReplaceDocument", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "Document Id to be replaced", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" }, { "name": "documentcontent", "in": "formData", "description": "The document to replace the existing one", "required": true, "type": "file" } ], "responses": { "204": { "description": "If replacement was successful.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If invalid parameters are provided." }, "403": { "description": "For invalid session or missing license" }, "404": { "description": "For not found or missing rights or if the resources could not be found." }, "500": { "description": "For unexpected error" } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/documents/{docid}/revisions": { "get": { "tags": [ "PublicApiDocuments" ], "summary": "Gets the revisons of a document", "operationId": "PublicApiDocuments_GetDocumentRevisions", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "Document Id", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the revision info on the document was found.", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.RevisionData" } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/revisions/{revisionid}/actions/accept_step": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "Performs revision step on given revision.", "operationId": "PublicApiDocuments_AcceptRevisionStep", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "revisionid", "in": "path", "description": "Revision Id", "required": true, "type": "string" }, { "name": "step", "in": "body", "description": "Revision step object", "required": true, "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.RevisionStep" } }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the revision step was performed.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the revision could not be performed" } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/{objid}/documents": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "Upload a document under a device/document as a copy.", "description": "The uploaded document can be in the form of pdf, word document etc.", "operationId": "PublicApiDocuments_AddDocumentToObject", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Object Id of parent", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "cobjectid", "in": "query", "description": "CObject Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" }, { "name": "documentcontent", "in": "formData", "description": "The document to upload as a child", "required": true, "type": "file" } ], "responses": { "201": { "description": "If the document was created successfully.", "schema": { "type": "string" } }, "400": { "description": "If one of the parameters is invalid" } }, "deprecated": false } }, "/public/api/dbs/{dbid}/documents/actions/estamp": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "EStamp the given pdf document.", "operationId": "PublicApiDocuments_EStampDocument", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" }, { "name": "documentcontent", "in": "formData", "description": "The document to eStamp", "required": true, "type": "file" } ], "responses": { "200": { "description": "If the document could be estamped", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If one of the parameters is invalid" }, "404": { "description": "If the related document could not be found" } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/documents/{docid}/actions/checkout": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "Checks out a document.", "description": "Note that this operation does not do a download -\r\n it must be done by calling the route \"... {projid}/documents/{docid}\".", "operationId": "PublicApiDocuments_PostDocumentCheckout", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "Document Id", "required": true, "type": "string" }, { "name": "comment", "in": "body", "description": "Checkout comment", "required": true, "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.DocumentComment" } }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Project language", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "204": { "description": "If document is successfully checked out.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the invalid parameters are provided." }, "403": { "description": "For invalid session or missing license" }, "404": { "description": "For not found or missing rights or if the resources could not be found." }, "500": { "description": "For unexpected error" } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/documents/{docid}/actions/undo_checkout": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "Undoes a document checkout.", "operationId": "PublicApiDocuments_PostDocumentUndoCheckout", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "Document Id", "required": true, "type": "string" }, { "name": "comment", "in": "body", "description": "Checkout comment", "required": true, "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.DocumentComment" } }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Project language", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "204": { "description": "If document is successfully undo check out.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the invalid parameters are provided." }, "403": { "description": "For invalid session or missing license" }, "404": { "description": "For not found or missing rights or if the resources could not be found." }, "500": { "description": "For unexpected error" } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/documents/{docid}/redlinings": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "Posts a new redlining document for a specific revision.", "operationId": "PublicApiDocuments_PostDocumentRevisionRedlining", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "revision Id", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Project language", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "204": { "description": "If redlining document is successfully added.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the invalid parameters are provided." }, "403": { "description": "For invalid session or missing license" }, "404": { "description": "For not found or missing rights or if the resources could not be found." }, "500": { "description": "For unexpected error" } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/documents/{docid}/actions/checkin": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "Checks in a document", "description": "\u003Cpara\u003EThis API can do a first checkin or a consecutive checkin.\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003ECheck if the document can be checked in , eg Check if the document is checked out .\u003C/li\u003E\r\n \u003Cli\u003EChecks for Mandatory Attributes\u003C/li\u003E\r\n \u003Cli\u003ECheck in the document\u003C/li\u003E\r\n\u003C/ul\u003E\r\n The API expects multi-part form data that consists of \r\n \u003Cbr /\u003E \r\n Sample format\r\n 1. values \r\n [{\r\n \"NestedName\":\"string\", //Required\r\n \"Value\":\"string\", \r\n \"SIValue\":\"double\",\r\n \"LinkObject\":{\r\n \"UID\":\"string\",\r\n \"ProjectUID\":\"string\",\r\n \"OverlayUID\":\"string\"\r\n },\r\n \"XValues\":[{\r\n \"Index\":\"int\",\r\n \"XValue\":\"string\",\r\n \"SIXValue\":\"double\"\r\n }]\r\n }]\r\n 2. comment\r\n \"comment\":\"string\"\r\n 3. file : The file to be checked in", "operationId": "PublicApiDocuments_PostDocumentCheckin", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "Can be a Document Placeholder UID or a Document UID", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "204": { "description": "If check-in is successful.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If invalid parameters are provided." }, "403": { "description": "For invalid session or missing license" }, "404": { "description": "For not found or missing rights or if the resources could not be found." }, "500": { "description": "For unexpected error" } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/documents/{docid}/actions/create_revision": { "post": { "tags": [ "PublicApiDocuments" ], "summary": "Posts a specific revision.", "operationId": "PublicApiDocuments_PostCreateDocumentRevision", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "docid", "in": "path", "description": "Document Id", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Project language", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the revision was posted successfully.", "schema": { "$ref": "#/definitions/Comos.Gateway.Contracts.ComosGatewayRefObject" } }, "404": { "description": "If the referenced dicument could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Gets a collection of projects", "operationId": "PublicApiProjects_GetProjects", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the projects could be fetched.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Project" } } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/{objid}": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Gets an object", "description": "\u003Cpara\u003EObject is fetched based on the object Id.\u003C/para\u003E\r\n\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - Default set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - Full set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields seperated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: Fields will be filtered out in case they are not applicable for the given object type. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E\r\n Fields supported by Objects based on the object type:\u003Cbr /\u003E\u003Cbr /\u003E\u003Ctable style=\"border:1px solid #000;word-break:break-all;padding:5px;\"\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Ctd style=\"width:15%;\"\u003EObject Type\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EDefault Fields\u003C/td\u003E\u003Ctd style=\"width:45%;\"\u003EAll Fields\u003C/td\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003ECDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExist\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Location,Unit\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Devices,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocument\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,Documents,Devices,DocObjs\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EProject\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,StandardTables,OwnStandardTables,Devices\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocObj\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Reference,Reference2\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Reference,Reference2\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EOther Types\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist\u003C/td\u003E\u003C/tr\u003E\u003C/tbody\u003E\u003C/table\u003E", "operationId": "PublicApiProjects_GetComosObjectPropertiesById", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Object Id", "required": true, "type": "string" }, { "name": "fields", "in": "query", "description": "Fields to reduce the retrieved properties to", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the object could be fetched.", "schema": { "$ref": "#/definitions/System.Object" } }, "404": { "description": "If the resources could not be found." }, "400": { "description": "If the request is invalid." } }, "deprecated": false }, "delete": { "tags": [ "PublicApiProjects" ], "summary": "Deletes the COMOS Object", "operationId": "PublicApiProjects_DeleteObject", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database ID", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project ID", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Object ID", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay ID", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Project language", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "201": { "description": "If the object was deleted successfully.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the resources could not be found." } }, "deprecated": false }, "patch": { "tags": [ "PublicApiProjects" ], "summary": "Updates the given object", "description": "\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - Default set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - Full set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields seperated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: Fields will be filtered out in case they are not applicable for the given object type. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E\r\n Fields supported by Objects based on the object type:\u003Cbr /\u003E\u003Cbr /\u003E\u003Ctable style=\"border:1px solid #000;word-break:break-all;padding:5px;\"\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Ctd style=\"width:15%;\"\u003EObject Type\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EDefault Fields\u003C/td\u003E\u003Ctd style=\"width:45%;\"\u003EAll Fields\u003C/td\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003ECDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExist\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Location,Unit\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel,CObject\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocument\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EOther Types\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist\u003C/td\u003E\u003C/tr\u003E\u003C/tbody\u003E\u003C/table\u003E\u003Cbr /\u003E \r\n Sample request for Device:\r\n \r\n PATCH\r\n {\r\n \"Name\":\"string\",\r\n \"Description\":\"string\",\r\n \"Label\":\"string\",\r\n \"CDevice\":{\r\n \"UID\":\"string\"\r\n },\r\n \"Owner\":{\r\n \"UID\":\"string\"\r\n }\r\n }\r\n Sample request for Document:\r\n \r\n PATCH\r\n {\r\n \"Name\":\"string\",\r\n \"Description\":\"string\",\r\n \"Description2\":\"string\",\r\n \"Description3\":\"string\",\r\n \"Label\":\"string\",\r\n \"CObject\":{\r\n \"UID\":\"string\"\r\n },\r\n \"DocumentType\":{\r\n \"UID\":\"string\"\r\n },\r\n \"OrgDocument\":{\r\n \"UID\":\"string\"\r\n },\r\n \"Owner\":{\r\n \"UID\":\"string\"\r\n }\r\n }", "operationId": "PublicApiProjects_UpdateObjectProperties", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Object Id", "required": true, "type": "string" }, { "name": "value", "in": "body", "description": "COMOS object with properties to update", "required": true, "schema": { "$ref": "#/definitions/System.Object" } }, { "name": "fields", "in": "query", "description": "Fields to reduce the retrieved properties to", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the object properties were updated successfully.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/overlays": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Gets a collection of working overlays", "operationId": "PublicApiProjects_GetWorkingOverlays", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the working layers could be fetched.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.WorkingOverlay" } } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false }, "post": { "tags": [ "PublicApiProjects" ], "summary": "Create a working layer", "operationId": "PublicApiProjects_CreateWorkingOverlay", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project name", "required": true, "type": "string" }, { "name": "Overlay", "in": "body", "description": "New Working Overlay", "required": true, "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.WorkingOverlayPost" } }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "201": { "description": "If the working layer was created successfully.", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.WorkingOverlay" } }, "400": { "description": "If the working layer could not be created because of invalid parameters" }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/object": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Gets the object properties", "description": "\u003Cpara\u003EObject is fetched based on the object's path full name.\u003C/para\u003E\r\n\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - Default set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - Full set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields separated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: Fields will be filtered out in case they are not applicable for the given object type. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E\r\n Fields supported by Objects based on the object type:\u003Cbr /\u003E\u003Cbr /\u003E\u003Ctable style=\"border:1px solid #000;word-break:break-all;padding:5px;\"\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Ctd style=\"width:15%;\"\u003EObject Type\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EDefault Fields\u003C/td\u003E\u003Ctd style=\"width:45%;\"\u003EAll Fields\u003C/td\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003ECDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExist\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Location,Unit\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Devices,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocument\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,Documents,Devices\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EOther Types\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist\u003C/td\u003E\u003C/tr\u003E\u003C/tbody\u003E\u003C/table\u003E", "operationId": "PublicApiProjects_GetComosObjectPropertiesByPathFullName", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "pathfullname", "in": "query", "description": "Path full name", "required": true, "type": "string" }, { "name": "fields", "in": "query", "description": "Fields to reduce the retrieved properties to", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the object properties could be fetched.", "schema": { "$ref": "#/definitions/System.Object" } }, "404": { "description": "If the resources could not be found." }, "400": { "description": "If the request is invalid." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/actions/bulk/read": { "post": { "tags": [ "PublicApiProjects" ], "summary": "Gets up to 1000 COMOS objects with given fields and specification information.", "description": "\u003Cpara\u003EObjects is fetched based on an array of object UIDs.\u003C/para\u003E\r\n\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - Default set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - Full set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields seperated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: \r\n \u003Cpara\u003EFields will be filtered out in case they are not applicable for the given object type. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\r\n nested_names and recursion_depth are applicable for 'Specifications' field which needs to be explicitly passed or will be available with '*'.\r\n \u003Cbr /\u003E\u003C/para\u003E\r\n Fields supported by Objects based on the object type:\u003Cbr /\u003E\u003Cbr /\u003E\u003Cbr /\u003E\r\n nested_names include the specification nested names. These can include the hierarchical child specifications as well.\r\n recursion_depth can have the following values:\r\n \u003Cul\u003E\u003Cli\u003E-1 : will fetch all the specification children until the maximum depth.\u003C/li\u003E\u003Cli\u003E0 (default) : will fetch immediate object specifications.\u003C/li\u003E\u003Cli\u003E2/3/4...etc : will fetch all the specification children until the specified recursion depth.\u003C/li\u003E\u003C/ul\u003E\u003Ctable style=\"border:1px solid #000;word-break:break-all;padding:5px;\"\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Ctd style=\"width:15%;\"\u003EObject Type\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EDefault Fields\u003C/td\u003E\u003Ctd style=\"width:45%;\"\u003EAll Fields\u003C/td\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003ECDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExist\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel,Specifications\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Location,Unit\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Devices,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel,Specifications\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocument\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,Description2,Description3,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,Documents,Devices,Specifications,CObject\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocObj\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Reference,Reference2\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Reference,Reference2\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EOther Types\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Specifications\u003C/td\u003E\u003C/tr\u003E\u003C/tbody\u003E\u003C/table\u003E", "operationId": "PublicApiProjects_GetComosObjects", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database UID", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project UID", "required": true, "type": "string" }, { "name": "filter", "in": "body", "description": "Filter to get only a part of the whole object list", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ComosUIDObject" } } }, { "name": "fields", "in": "query", "description": "Fields to reduce the retrieved properties to", "required": false, "type": "string" }, { "name": "nested_names", "in": "query", "description": "Specification nested names that should be returned additionally to the fields", "required": false, "type": "string" }, { "name": "recursion_depth", "in": "query", "description": "Specifications children to be fetch until what depth.", "required": false, "type": "integer", "format": "int32" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the objects could be fetched.", "schema": { "$ref": "#/definitions/System.Object" } }, "404": { "description": "If the resources could not be found." }, "400": { "description": "If the request is invalid." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/languages": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Gets a collection of supported languages", "operationId": "PublicApiProjects_GetProjectLanguages", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the languages could be fetched.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Language" } } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/languages/default": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Gets default project language", "operationId": "PublicApiProjects_GetProjectDefaultLanguage", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the project language could be fetched.", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Language" } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/{objid}/specs": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Get the specifications for an object", "description": "\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - The specifications will have \"Name,Description\" fields.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - The specifications will have \"NestedName,Description,Value,DisplayValue,LValue,SIValue,ControlType,Unit,RangeType,Type,TabIndex,PhysUnitLabel,Precision,Length,Count,LinkObject,StandardTable,XValues\" fields.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields seperated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: Fields will be filtered out in case they are not a part of the specifications. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E\u003Cbr /\u003E\r\n nested_names include the specification nested names. These can include the hierarchical child specifications as well.\r\n recursion_depth can have the following values:\r\n \u003Cul\u003E\u003Cli\u003E-1 : will fetch all the specification children until the maximum depth.\u003C/li\u003E\u003Cli\u003E0 (default) : will fetch immediate object specifications.\u003C/li\u003E\u003Cli\u003E2/3/4...etc : will fetch all the specification children until the specified recursion depth.\u003C/li\u003E\u003C/ul\u003E", "operationId": "PublicApiProjects_GetSpecifications", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project id", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Object Id", "required": true, "type": "string" }, { "name": "fields", "in": "query", "description": "Fields to be displayed for specifications", "required": false, "type": "string" }, { "name": "nested_names", "in": "query", "description": "Nested names of specifications to be included in response", "required": false, "type": "string" }, { "name": "recursion_depth", "in": "query", "description": "Specifications children to be fetch until what depth.", "required": false, "type": "integer", "format": "int32" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the object specifications could be fetched.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Specification" } } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the resources could not be found." } }, "deprecated": false }, "patch": { "tags": [ "PublicApiProjects" ], "summary": "Updates the specifications for an object", "description": "\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - The specifications will have \"Name,Description\" fields.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - The specifications will have \"NestedName,Description,Value,DisplayValue,LValue,SIValue,ControlType,Unit,RangeType,Type,TabIndex,PhysUnitLabel,Precision,Length,Count,LinkObject,XValues\" fields.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields seperated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: fields will be filtered out in case they are not a part of the specifications. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E \r\n Sample request:\r\n \r\n PATCH\r\n [\r\n {\r\n \"NestedName\":\"string\", //Required\r\n \"Value\":\"string\", \r\n \"SIValue\":\"double\",\r\n \"LinkObject\":{\r\n \"UID\":\"string\",\r\n \"ProjectUID\":\"string\",\r\n \"OverlayUID\":\"string\"\r\n },\r\n \"XValues\":[{\r\n \"Index\":\"int\",\r\n \"XValue\":\"string\",\r\n \"SIXValue\":\"double\"\r\n }]\r\n }\r\n ]", "operationId": "PublicApiProjects_SetSpecifications", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project id", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Object id", "required": true, "type": "string" }, { "name": "values", "in": "body", "description": "Collection of specifications to be updated.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/System.Object" } } }, { "name": "fields", "in": "query", "description": "Fields to be displayed for specifications", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the the specifications where updated successfully.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/{objid}/specs/actions/validate": { "post": { "tags": [ "PublicApiProjects" ], "summary": "Validates the specifications update", "description": "\u003Cpara\u003EThis API will verify the request to update the specifications.(No specification will be updated).\u003C/para\u003E\r\n\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - The specifications will have \"Name,Description\" fields.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - The specifications will have \"NestedName,Description,Value,DisplayValue,LValue,SIValue,ControlType,Unit,RangeType,Type,TabIndex,PhysUnitLabel,Precision,Length,Count,LinkObject,XValues\" fields.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields seperated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: fields will be filtered out in case they are not a part of the specifications. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E \r\n Sample request:\r\n \r\n POST\r\n [\r\n {\r\n \"NestedName\":\"string\", //Required\r\n \"Value\":\"string\", \r\n \"SIValue\":\"double\",\r\n \"LinkObject\":{\r\n \"UID\":\"string\",\r\n \"ProjectUID\":\"string\",\r\n \"OverlayUID\":\"string\"\r\n },\r\n \"XValues\":[{\r\n \"Index\":\"int\",\r\n \"XValue\":\"string\",\r\n \"SIXValue\":\"double\"\r\n }]\r\n }\r\n ]", "operationId": "PublicApiProjects_ValidateSpecifications", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project id", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Comos specifaction object id", "required": true, "type": "string" }, { "name": "values", "in": "body", "description": "Collection of specifications to be updated.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/System.Object" } } }, { "name": "fields", "in": "query", "description": "Fields to be displayed for specifications", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language id", "required": false, "type": "string" }, { "name": "check_mandatory", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the specification update is valid.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the request is invalid." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/queries/{qid}/result": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Gets the data for a given query", "operationId": "PublicApiProjects_GetQueryData", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "qid", "in": "path", "description": "Query object Id", "required": true, "type": "string" }, { "name": "start_objid", "in": "query", "description": "Start object for the query", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Project language", "required": false, "type": "string" }, { "name": "export_type", "in": "query", "description": "Export type. At the moment the type 'query2excel' is supported.", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the data was found.", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.QueryResult" } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects": { "post": { "tags": [ "PublicApiProjects" ], "summary": "Create new object under the existing object", "description": "\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - Default set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - Full set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields separated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: Fields will be filtered out in case they are not applicable for the given object type. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E\r\n Fields supported by Objects based on the object type:\u003Cbr /\u003E\u003Cbr /\u003E\u003Ctable style=\"border:1px solid #000;word-break:break-all;padding:5px;\"\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Ctd style=\"width:15%;\"\u003EObject Type\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EDefault Fields\u003C/td\u003E\u003Ctd style=\"width:45%;\"\u003EAll Fields\u003C/td\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003ECDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExist\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Location,Unit\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocument\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,CObject\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EOther Types\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist\u003C/td\u003E\u003C/tr\u003E\u003C/tbody\u003E\u003C/table\u003E\u003Cbr /\u003E \r\n Sample request for Device Object:\r\n \r\n POST\r\n {\r\n \"Name\":\"string\",\r\n \"Description\":\"string\",\r\n \"Label\":\"string\",\r\n \"CDevice\":{\r\n \"UID\":\"string\"\r\n },\r\n \"Owner\":{ //Required\r\n \"UID\":\"string\"\r\n }\r\n } \r\n \r\n Sample request for Document Object:\r\n POST\r\n {\r\n \"Name\":\"string\",\r\n \"Description\":\"string\",\r\n \"Description2\":\"string\",\r\n \"Description3\":\"string\",\r\n \"Label\":\"string\",\r\n \"CObject\":{ \r\n \"UID\":\"string\"\r\n },\r\n \"DocumentType\":{\r\n \"UID\":\"string\"\r\n },\r\n \"OrgDocument\":{\r\n \"UID\":\"string\"\r\n },\r\n \"Owner\":{ //Required\r\n \"UID\":\"string\"\r\n }\r\n }", "operationId": "PublicApiProjects_CreateComosObject", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "value", "in": "body", "description": "New COMOS Object", "required": true, "schema": { "$ref": "#/definitions/System.Object" } }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "fields", "in": "query", "description": "Fields to reduce the retrieved properties to", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "201": { "description": "If the object was created.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the parent object could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/actions/bulk/update": { "patch": { "tags": [ "PublicApiProjects" ], "summary": "Update object properties in hierarchy", "description": "\u003Cpara\u003EInput parameters for updating COMOS object\u003C/para\u003E\r\n\u003Cbr /\u003E \r\n \r\n Sample request: \r\n {\r\n \"Selection\":{ \r\n \"StartObject\": { \r\n \"UID\": \"string\"\r\n }\r\n },\r\n \"Update\":{ \r\n \"Lock\": false\r\n }\r\n }", "operationId": "PublicApiProjects_BulkUpdate", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database ID", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project ID", "required": true, "type": "string" }, { "name": "value", "in": "body", "description": "Input parameters for updating COMOS object", "required": true, "schema": { "$ref": "#/definitions/System.Object" } }, { "name": "overlayid", "in": "query", "description": "Overlay ID", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Project language ID", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the objects were updated successfully.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/actions/bulk/patch": { "post": { "tags": [ "PublicApiProjects" ], "summary": "Updates the given object", "description": "\u003Cpara\u003EThe fields parameter can have the following valid values:\u003C/para\u003E\r\n\u003Cul\u003E\r\n \u003Cli\u003E\"\" - Default set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"*\" - Full set of fields for the object.\u003C/li\u003E\r\n \u003Cli\u003E\"field1,field2\" - Valid set of fields separated by comma for the object. ex. Name,Description,...,etc\u003C/li\u003E\r\n \u003Cli\u003E\"Specifications(Name,value,...)\" - Special keyword Specifications to filter on specifications level\u003C/li\u003E\r\n\u003C/ul\u003E\r\n Note: Fields will be filtered out in case they are not applicable for the given object type. If all fields specified are invalid, then a BadRequest error will be thrown.\u003Cbr /\u003E\u003Cbr /\u003E\u003Cbr /\u003E\r\n nested_names include the specification nested names. These can include the hierarchical child specifications as well.\r\n recursion_depth can have the following values:\r\n \u003Cul\u003E\u003Cli\u003E-1 : will fetch all the specification children until the maximum depth.\u003C/li\u003E\u003Cli\u003E0 (default) : will fetch immediate object specifications.\u003C/li\u003E\u003Cli\u003E2/3/4...etc : will fetch all the specification children until the specified recursion depth.\u003C/li\u003E\u003C/ul\u003E \r\n Fields supported by Objects based on the object type:\u003Cbr /\u003E\u003Cbr /\u003E\u003Ctable style=\"border:1px solid #000;word-break:break-all;padding:5px;\"\u003E\u003Cthead\u003E\u003Ctr\u003E\u003Ctd style=\"width:15%;\"\u003EObject Type\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EDefault Fields\u003C/td\u003E\u003Ctd style=\"width:45%;\"\u003EAll Fields\u003C/td\u003E\u003C/tr\u003E\u003C/thead\u003E\u003Ctbody\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003ECDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Class,XObjExist\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,OwnLabel,Specifications\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDevice\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,Location,Unit\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Class,DetailClass,CDevice,BackPointerDocObjs,Documents,Location,Unit,Implementation,BackPointerDevicesWithImplementation,OwnLabel,Specifications\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EDocument\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID,OrgDocument,Location,Unit,DocumentType\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Description2,Description3,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,OrgDocument,Location,Unit,DocumentType,BackPointerDocumentsWithOrgDocument,IsDdmDocument,IsDocumentExportable,DocumentExtension,DocumentHasReleaseRevision,OwnLabel,Specifications\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003ESpecifications\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003ENestedName,Description,Value,DisplayValue,LValue,SIValue,ControlType,Unit,RangeType,Type,TabIndex,PhysUnitLabel,Precision,Length,Count,LinkObject,XValues,Specifications\u003C/td\u003E\u003C/tr\u003E\u003Ctr\u003E\u003Ctd style=\"width:10%;\"\u003EOther Types\u003C/td\u003E\u003Ctd style=\"width:40%;\"\u003EName,Description,FullLabel,SystemType,UID,SystemUID\u003C/td\u003E\u003Ctd style=\"width:50%;\"\u003EName,FullName,Description,Label,FullLabel,SystemType,Owner,UID,SystemUID,SystemTemporary,XObjExist,Specifications\u003C/td\u003E\u003C/tr\u003E\u003C/tbody\u003E\u003C/table\u003E\u003Cbr /\u003E \r\n Sample request:\r\n \r\n POST\r\n [\r\n { \r\n \"UID\": \"string\",\r\n \"Specifications\": [{\r\n \"NestedName\": \"string\",\r\n \"Value\": \"string\",\r\n \"SIValue\": \"double\",\r\n \"LinkObject\": {\r\n \"UID\": \"string\",\r\n \"ProjectUID\": \"string\",\r\n \"OverlayUID\": \"string\"\r\n },\r\n \"XValues\": [\r\n {\r\n \"Index\": \"int\",\r\n \"XValue\": \"string\",\r\n \"SIXValue\": \"double\"\r\n }\r\n ]\r\n }],\r\n \"Name\": \"string\",\r\n \"Description\": \"string\",\r\n \"Label\": \"string\",\r\n \"CDevice\": {\r\n \"UID\": \"string\"\r\n },\r\n \"OrgDocument\":{\r\n \"UID\":\"string\"\r\n },\r\n \"Owner\": {\r\n \"UID\": \"string\"\r\n }\r\n },\r\n { //Sample request for Document\r\n \"UID\": \"string\",\r\n \"Specifications\": [{\r\n \"NestedName\": \"string\",\r\n \"Value\": \"string\",\r\n \"SIValue\": \"double\",\r\n \"LinkObject\": {\r\n \"UID\": \"string\",\r\n \"ProjectUID\": \"string\",\r\n \"OverlayUID\": \"string\"\r\n },\r\n \"XValues\": [\r\n {\r\n \"Index\": \"int\",\r\n \"XValue\": \"string\",\r\n \"SIXValue\": \"double\"\r\n }\r\n ]\r\n }],\r\n \"Name\":\"string\",\r\n \"Description\":\"string\",\r\n \"Description2\":\"string\",\r\n \"Description3\":\"string\",\r\n \"Label\":\"string\",\r\n \"CObject\":{\r\n \"UID\":\"string\"\r\n },\r\n \"DocumentType\":{\r\n \"UID\":\"string\"\r\n },\r\n \"OrgDocument\":{\r\n \"UID\":\"string\"\r\n },\r\n \"Owner\":{\r\n \"UID\":\"string\"\r\n }\r\n }\r\n ]", "operationId": "PublicApiProjects_UpdateBulkObjectProperties", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "values", "in": "body", "description": "COMOS objects with properties or specifications to update", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/System.Object" } } }, { "name": "fields", "in": "query", "description": "Fields to return in the response after update", "required": false, "type": "string" }, { "name": "nested_names", "in": "query", "description": "List of specification nested names to return after update", "required": false, "type": "string" }, { "name": "recursion_depth", "in": "query", "description": "Specifications children to be fetch until what depth.", "required": false, "type": "integer", "format": "int32" }, { "name": "overlayid", "in": "query", "description": "Working Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If properties were updated successfully.", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/objects/{objid}/standard_values": { "get": { "tags": [ "PublicApiProjects" ], "summary": "Get Standard Table Values.", "operationId": "PublicApiProjects_GetStandardTableValuesForAPI", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "objid", "in": "path", "description": "Object Id of standard table", "required": true, "type": "string" }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the standard table values could be fetched.", "schema": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.StandardTableRow" } } }, "404": { "description": "If the resources could not be found." } }, "deprecated": false } }, "/public/api/projects/v1/dbs/{dbid}/projects/{projid}/actions/script_execution": { "post": { "tags": [ "PublicApiProjects" ], "summary": "Executes a custom script for a given project.", "description": "\u003Cp\u003EThis endpoint allows execution of a script defined in the COMOS system for a specific project.\u003C/p\u003E\r\n\u003Cp\u003EThe script must exist under the customer scripts path (\"@20|A80|Z10|\").\u003C/p\u003E\r\n\u003Csection\u003E\r\n \u003Ch4\u003ESample Request\u003C/h4\u003E\r\n \u003Cdiv\u003E\r\n \u003Cpre\u003E\r\n \u003Cb\u003E\r\n {\r\n \"SystemFullName\": \"@20|A80|Z10|ComosObjectName\", // Full system path of the COMOS object on which the script is to be executed. Required\r\n \"ScriptName\": \"CallScriptName\", // Name of the script to execute. Required\r\n \"Params\": [ // Array of parameters to pass to the script. Optional.\r\n null, // Null parameter \r\n \"\", // Empty string parameter\r\n \"string param\", // String parameter\r\n 1, // Integer\\Long parameter\r\n 22.5, // Double parameter\r\n true, // Boolean parameter (case sensitive)\r\n {\"UID\": \"U:8:A3BQHN2KAR:U\"}, // Comos Object parameter by UID \r\n {\"PathFullName\": \"08UP1ยง>08UH3\"} // Comos Object parameter by PathFullName\r\n ]\r\n }\r\n \u003C/b\u003E\r\n \u003C/pre\u003E\r\n \u003C/div\u003E\r\n\u003C/section\u003E\r\n\u003Csection\u003E\r\n \u003Ch4\u003ESample Response\u003C/h4\u003E\r\n \u003Cdiv\u003E\r\n \u003Cpre\u003E\r\n \u003Cb\u003E\r\n {\r\n \"Result\": 1 OR 22.5 OR true\\false OR \"string result\" OR null OR {\"UID\":\"U:8:A3BQHN2KAR:U\"},\r\n \"Error\": { // Null if no error occurred during script execution.\r\n \"Code\": ,\r\n \"Message\": \"string\"\r\n }\r\n }\r\n \u003C/b\u003E\r\n \u003C/pre\u003E\r\n \u003C/div\u003E\r\n \u003Cb\u003EResult property inside the response can be one of the following types\u003C/b\u003E\r\n \u003Cul\u003E\r\n \u003Cli\u003E\r\n \u003Cb\u003ENumeric\u003C/b\u003E Ex. 2 OR 22.56\u003C/li\u003E\r\n \u003Cli\u003E\r\n \u003Cb\u003EString\u003C/b\u003E Ex. \"This is a response result string\"\u003C/li\u003E\r\n \u003Cli\u003E\r\n \u003Cb\u003EBoolean\u003C/b\u003E Ex. true OR false\u003C/li\u003E\r\n \u003Cli\u003E\r\n \u003Cb\u003EComos Object\u003C/b\u003E Ex. {\"UID\": \"U:8:A3BQHN2KAR:U\"}\u003C/li\u003E\r\n \u003Cli\u003E\r\n \u003Cb\u003Enull\u003C/b\u003E\r\n \u003C/li\u003E\r\n \u003C/ul\u003E\r\n \u003Cb\u003E\r\n \u003Ci\u003ENote: \u003C/i\u003EError property inside the response, will be null for successful script execution.\u003C/b\u003E\r\n \u003Cb\u003EIn case of script execution error, Error property inside the response will have a message and the following code types\u003C/b\u003E\r\n \u003Cul\u003E\r\n \u003Cli\u003E\r\n \u003Cb\u003E6\u003C/b\u003E: The script was invoked, but resulted in an error thrown by the script or the script with the given name does not exist under the object.\u003C/li\u003E\r\n \u003Cli\u003E\r\n \u003Cb\u003E10\u003C/b\u003E: The script executed successfully, but the returntype is not supported by this API.\u003C/li\u003E\r\n \u003C/ul\u003E\r\n\u003C/section\u003E", "operationId": "PublicApiProjects_ScriptExecution", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "dbid", "in": "path", "description": "Database Id", "required": true, "type": "string" }, { "name": "projid", "in": "path", "description": "Project Id", "required": true, "type": "string" }, { "name": "scriptExecutionInfo", "in": "body", "description": "Script execution request body", "required": true, "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ScriptExecutionInfo" } }, { "name": "overlayid", "in": "query", "description": "Overlay Id", "required": false, "type": "string" }, { "name": "lcid", "in": "query", "description": "Language Id", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "Script executed successfully. Returns {Comos.PublicApi.Services.Models.ScriptExecutionResult}.", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ScriptExecutionResult" } }, "400": { "description": "Invalid request or parameters." }, "404": { "description": "Comos object or project not found." } }, "deprecated": false } }, "/public/api/sessions/v1/sessions/actions/login": { "post": { "tags": [ "PublicApiSessions" ], "summary": "Creates a new session for the current user", "operationId": "PublicApiSessions_Login", "consumes": [], "produces": [ "application/json", "text/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Login" } } }, "deprecated": false } }, "/public/api/sessions/v1/sessions/actions/logout": { "post": { "tags": [ "PublicApiSessions" ], "summary": "Remove the session based on session Id", "operationId": "PublicApiSessions_DeleteSession", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Logout" } } }, "deprecated": false } }, "/public/api/sessions/v1/sessions/actions/send_heartbeat": { "post": { "tags": [ "PublicApiSessions" ], "summary": "Update the specified session (heartbeat) passed", "operationId": "PublicApiSessions_SendHeartbeat", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Logout" } } }, "deprecated": false } }, "/public/api/users/v1/users/current_user": { "get": { "tags": [ "PublicApiUsers" ], "summary": "Get the details of the current user", "operationId": "PublicApiUsers_GetCurrentUserFromUsersService", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the current user could be fetched.", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.CurrentUser" } }, "404": { "description": "If no user was found." } }, "deprecated": false } }, "/public/api/users/v1/users": { "post": { "tags": [ "PublicApiUsers" ], "summary": "Creates a new user with the given details", "operationId": "PublicApiUsers_CreateUser", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "newUser", "in": "body", "description": "The details of the user to be created", "required": true, "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.UserPost" } }, { "name": "dbid", "in": "query", "description": "The database id in case the database configured in the users service is not to be used", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "201": { "description": "If new user is created.", "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.User" } }, "404": { "description": "If invalid user details." }, "403": { "description": "If user does not have the rights to create user." } }, "deprecated": false } }, "/public/api/users/v1/groups/{group_name}/members": { "post": { "tags": [ "PublicApiUsers" ], "summary": "Adds a user to a group", "operationId": "PublicApiUsers_AddUserToGroup", "consumes": [ "application/json", "text/json", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "userIdentifier", "in": "body", "description": "user identifier object with username", "required": true, "schema": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.UserIdentifier" } }, { "name": "group_name", "in": "path", "description": "Name of the group the user will be added to", "required": true, "type": "string" }, { "name": "dbid", "in": "query", "description": "The database id in case the database configured in the users service is not to be used", "required": false, "type": "string" }, { "name": "projid", "in": "query", "description": "The system UID of the project (only needed for roles)", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "The system UID of the working layer (only needed for roles)", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "If the user was added to the group", "schema": { "$ref": "#/definitions/System.Object" } }, "400": { "description": "If one or more of the passed parameters was invalid" } }, "deprecated": false } }, "/public/api/users/v1/groups/{group_name}/members/{user_name}": { "delete": { "tags": [ "PublicApiUsers" ], "summary": "Removes a user from a group", "operationId": "PublicApiUsers_RemoveUserFromGroup", "consumes": [], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "group_name", "in": "path", "description": "Name of the group the user will be removed from", "required": true, "type": "string" }, { "name": "user_name", "in": "path", "description": "Name of the user", "required": true, "type": "string" }, { "name": "dbid", "in": "query", "description": "The database id in case the database configured in the users service is not to be used", "required": false, "type": "string" }, { "name": "projid", "in": "query", "description": "The system UID of the project (only needed for roles)", "required": false, "type": "string" }, { "name": "overlayid", "in": "query", "description": "The system UID of the working layer (only needed for roles)", "required": false, "type": "string" }, { "name": "Comos-API-Session", "in": "header", "description": "Comos SessionId that needs to be passed with every request except Login ", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/System.Object" } } }, "deprecated": false } } }, "definitions": { "Comos.PublicApi.Services.Models.Discovery": { "description": "Discovery Model", "type": "object", "properties": { "Name": { "description": "Service Name", "type": "string" }, "Versions": { "description": "Service Versions", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.DiscoveryVersion" } } } }, "Comos.PublicApi.Services.Models.DiscoveryVersion": { "description": "Discovery Version", "type": "object", "properties": { "VersionNumber": { "description": "VersionNumber", "type": "string" }, "Path": { "description": "Path", "type": "string" } } }, "System.Object": { "type": "object", "properties": { } }, "Comos.PublicApi.Services.Models.RevisionData": { "description": "RevisionData", "type": "object", "properties": { "Steps": { "description": "Steps", "type": "array", "items": { "type": "string" } }, "Revisions": { "description": "Revisions", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.Revision" } } } }, "Comos.PublicApi.Services.Models.Revision": { "description": "Revision", "type": "object", "properties": { "Label": { "description": "Label", "type": "string" }, "Elements": { "description": "Elements", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.RevisionElement" } }, "AdditionalDocuments": { "description": "AdditionalDocuments", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.DocElement" } }, "RedLinings": { "description": "RedLinings", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.DocElement" } }, "IsFileAvailable": { "description": "IsFileAvailable", "type": "boolean" }, "Name": { "description": "Name", "type": "string" }, "Description": { "description": "Description", "type": "string" }, "UID": { "description": "UID", "type": "string" }, "ProjectUID": { "description": "Project UID", "type": "string" }, "OverlayUID": { "description": "Overlay UID", "type": "string" } } }, "Comos.PublicApi.Services.Models.RevisionElement": { "description": "Revision Element", "type": "object", "properties": { "Created": { "format": "date-time", "description": "Created", "type": "string" }, "Author": { "description": "Author", "type": "string" }, "OwnLabel": { "description": "OwnLabel", "type": "string" }, "OwnDescription": { "description": "OwnDescription", "type": "string" } } }, "Comos.PublicApi.Services.Models.DocElement": { "description": "Document Element", "type": "object", "properties": { "CreateUserName": { "description": "CreateUserName", "type": "string" }, "CreateTimestamp": { "description": "CreateTimestamp", "type": "string" }, "UID": { "description": "Document element UID", "type": "string" } } }, "Comos.PublicApi.Services.Models.RevisionStep": { "description": "Revision Step", "type": "object", "properties": { "StepId": { "format": "int32", "description": "Revision step Id. 1: Created By, 2: Checked By, 3: Released By", "type": "integer" }, "Label": { "description": "Revision step label", "type": "string" }, "Description": { "description": "Revision step description", "type": "string" } } }, "Comos.PublicApi.Services.Models.DocumentComment": { "description": "checkout or Undo checkout comment", "type": "object", "properties": { "Comment": { "description": "comment for checkout or Undo checkout comment", "type": "string" } } }, "Comos.Gateway.Contracts.ComosGatewayRefObject": { "type": "object", "properties": { "ComosDatabase": { "type": "string" }, "ComosProjId": { "type": "string" }, "ComosWoId": { "type": "string" }, "ComosObjectUid": { "type": "string" }, "ComosSystemType": { "type": "string" }, "HClassification": { "type": "string" }, "Name": { "type": "string" }, "Label": { "type": "string" }, "Description": { "type": "string" } } }, "Comos.PublicApi.Services.Models.Project": { "description": "Project", "type": "object", "properties": { "Name": { "description": "Project Name", "type": "string" }, "Description": { "description": "Project Description", "type": "string" }, "UID": { "description": "Project UID", "type": "string" }, "SystemFullName": { "description": "Project System full name", "type": "string" } } }, "Comos.PublicApi.Services.Models.WorkingOverlay": { "description": "Working Overlay", "type": "object", "properties": { "Name": { "description": "Name", "type": "string" }, "Description": { "description": "Description", "type": "string" }, "UID": { "description": "Working Overlay UID", "type": "string" }, "SystemFullName": { "description": "System full Name", "type": "string" } } }, "Comos.PublicApi.Services.Models.WorkingOverlayPost": { "description": "Working Overlay", "type": "object", "properties": { "Name": { "description": "Name", "type": "string" }, "Description": { "description": "Description", "type": "string" }, "Owner": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ComosUIDObject" }, "ConnectedBaseWorkingOverlay": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ComosUIDObject" } } }, "Comos.PublicApi.Services.Models.ComosUIDObject": { "description": "UID Object", "type": "object", "properties": { "UID": { "description": "UID", "type": "string" } } }, "Comos.PublicApi.Services.Models.Language": { "description": "Language", "type": "object", "properties": { "LCID": { "description": "Language Id", "type": "string" }, "Description": { "description": "Description", "type": "string" } } }, "Comos.PublicApi.Services.Models.Specification": { "description": "Specification", "type": "object", "properties": { "NestedName": { "description": "NestedName", "type": "string" }, "Description": { "description": "Description", "type": "string" }, "Value": { "description": "Value", "type": "string" }, "DisplayValue": { "description": "Display values", "type": "string" }, "LValue": { "description": "LValue", "type": "string" }, "SIValue": { "format": "double", "description": "SIValue", "type": "number" }, "ControlType": { "description": "ControlType", "type": "string" }, "Unit": { "description": "Unit", "type": "string" }, "RangeType": { "format": "int32", "description": "RangeType", "type": "integer" }, "Type": { "description": "Type", "type": "string" }, "TabIndex": { "format": "int32", "description": "TabIndex", "type": "integer" }, "PhysUnitLabel": { "description": "PhysUnitLabel", "type": "string" }, "Precision": { "format": "int32", "description": "Precision", "type": "integer" }, "Length": { "format": "int32", "description": "Length", "type": "integer" }, "Count": { "format": "int32", "description": "Count", "type": "integer" }, "StandardTable": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ComosUIDObject" }, "LinkObject": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ComosLinkObject" }, "XValues": { "description": "XValues", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ComosXValue" } } } }, "Comos.PublicApi.Services.Models.ComosLinkObject": { "description": "Comos LinkObject", "type": "object", "properties": { "UID": { "description": "LinkObject Id", "type": "string" }, "ProjectUID": { "description": "Project Id", "type": "string" }, "OverlayUID": { "description": "Working Overlay Id", "type": "string" } } }, "Comos.PublicApi.Services.Models.ComosXValue": { "description": "Comos XValue", "type": "object", "properties": { "Index": { "format": "int32", "description": "Index", "type": "integer" }, "XValue": { "description": "XValue", "type": "string" }, "DisplayXValue": { "description": "Display XValue", "type": "string" }, "LXValue": { "description": "LXValue", "type": "string" }, "SIXValue": { "format": "double", "description": "SIXValue", "type": "number" } } }, "Comos.PublicApi.Services.Models.QueryResult": { "description": "Query Result", "type": "object", "properties": { "Columns": { "description": "Query result columns", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.QueryResultColumn" } }, "Rows": { "description": "Query result rows", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.QueryResultRow" } } } }, "Comos.PublicApi.Services.Models.QueryResultColumn": { "description": "Query Result Columns", "type": "object", "properties": { "Id": { "format": "int32", "description": "Id", "type": "integer" }, "Alignment": { "format": "int32", "description": "Alignment", "enum": [0, 1, 2], "type": "integer" }, "Width": { "format": "int32", "description": "Width", "type": "integer" }, "Visible": { "description": "Visible", "type": "boolean" }, "DisplayDescription": { "description": "Display Description", "type": "string" }, "Numeric": { "description": "Numeric", "type": "boolean" }, "WrapText": { "description": "WrapText", "type": "boolean" }, "IsDate": { "description": "IsDate", "type": "boolean" } } }, "Comos.PublicApi.Services.Models.QueryResultRow": { "description": "Query Result Row", "type": "object", "properties": { "UID": { "description": "Row UID", "type": "string" }, "Items": { "description": "Items", "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.QueryResultItem" } } } }, "Comos.PublicApi.Services.Models.QueryResultItem": { "description": "Query Result Item", "type": "object", "properties": { "UID": { "description": "Item UID", "type": "string" }, "Text": { "description": "Texts", "type": "string" }, "NumericValue": { "format": "double", "description": "NumericValue", "type": "number" } } }, "Comos.PublicApi.Services.Models.StandardTableRow": { "description": "", "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "XValueCount": { "format": "int32", "type": "integer" }, "XValue": { "type": "array", "items": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.XValueData" } } } }, "Comos.PublicApi.Services.Models.XValueData": { "description": "", "type": "object", "properties": { "Index": { "format": "int32", "type": "integer" }, "XValue": { "type": "string" } } }, "Comos.PublicApi.Services.Models.ScriptExecutionInfo": { "description": "ScriptExecutionInfo", "type": "object", "properties": { "SystemFullName": { "description": "SystemFullName", "type": "string" }, "ScriptName": { "description": "ScriptName", "type": "string" }, "Params": { "description": "Script Parameters", "type": "array", "items": { "$ref": "#/definitions/System.Object" } } } }, "Comos.PublicApi.Services.Models.ScriptExecutionResult": { "description": "ScriptExecutionResult", "type": "object", "properties": { "Result": { "$ref": "#/definitions/System.Object", "description": "Result" }, "Error": { "$ref": "#/definitions/Comos.PublicApi.Services.Models.ScriptExecutionError", "description": "Error" } } }, "Comos.PublicApi.Services.Models.ScriptExecutionError": { "description": "ScriptExecutionError", "type": "object", "properties": { "Code": { "format": "int32", "description": "Error Code", "type": "integer" }, "Message": { "description": "Error Message", "type": "string" } } }, "Comos.PublicApi.Services.Models.Login": { "description": "Login", "type": "object", "properties": { "SessionId": { "description": "SessionId", "type": "string" }, "UserName": { "description": "UserName", "type": "string" }, "HeartbeatInterval": { "format": "int32", "description": "HeartbeatInterval", "type": "integer" } } }, "Comos.PublicApi.Services.Models.Logout": { "description": "Logout", "type": "object", "properties": { "SessionId": { "description": "SessionId", "type": "string" } } }, "Comos.PublicApi.Services.Models.CurrentUser": { "description": "Current User", "required": [ "UserName" ], "type": "object", "properties": { "IsPM": { "description": "Is Project Manager", "type": "boolean" }, "FirstName": { "description": "FirstName", "type": "string" }, "LastName": { "description": "LastName", "type": "string" }, "UserName": { "description": "UserName", "type": "string" } } }, "Comos.PublicApi.Services.Models.UserPost": { "description": "UserPost", "required": [ "DepartmentUID", "UserName" ], "type": "object", "properties": { "DepartmentUID": { "description": "DepartmentUID", "type": "string" }, "Email": { "description": "Email", "type": "string" }, "FirstName": { "description": "FirstName", "type": "string" }, "LastName": { "description": "LastName", "type": "string" }, "UserName": { "description": "UserName", "type": "string" } } }, "Comos.PublicApi.Services.Models.User": { "description": "User", "required": [ "UserName" ], "type": "object", "properties": { "FirstName": { "description": "FirstName", "type": "string" }, "LastName": { "description": "LastName", "type": "string" }, "UserName": { "description": "UserName", "type": "string" } } }, "Comos.PublicApi.Services.Models.UserIdentifier": { "description": "User Name Identifier object", "required": [ "UserName" ], "type": "object", "properties": { "UserName": { "description": "UserName", "type": "string" } } } } }