{"items":[{"type":"link","label":"Symbio Business Manager","link":"/cpm/developer/openapi/openapi","routeSlug":"/cpm/developer/openapi/openapi","content":{"contentType":"overview","meta":{"name":"Symbio Business Manager"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/cpm/developer/openapi/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/cpm/developer/openapi/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.celonis.com","url":"https://www.celonis.com"},{"kind":"email","title":"Celonis SE","email":"info@celonis.com","label":"info@celonis.com","withCopyButton":true,"copyContent":"info@celonis.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Symbio Business Manager (v1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Public API for Symbio Business Manager"}],"sectionId":"/cpm/developer/openapi/openapi"}],"sectionId":"/cpm/developer/openapi/openapi"}]}]}},{"type":"group","label":"BPMN API (Version 1)","link":"/cpm/developer/openapi/openapi/bpmn-api-(version-1)","routeSlug":"/cpm/developer/openapi/openapi/bpmn-api-(version-1)","items":[{"label":"Creates BPML XML definition for the given element.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/bpmn-api-(version-1)/bpmnv1_export","routeSlug":"/cpm/developer/openapi/openapi/bpmn-api-(version-1)/bpmnv1_export","metadata":{"seo":{"title":"Creates BPML XML definition for the given element.","description":"Creates BPML XML definition for the given element."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BpmnV1_Export","name":"Creates BPML XML definition for the given element.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates BPML XML definition for the given element.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The origin key of the element to export.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lcid","in":"query","schemaId":"schema_133","description":"The lcid to export the bpmn in. 0 as default, will use default data culture of the context."},{"name":"exportRepositoryElements","in":"query","schemaId":"schema_134","description":"Boolean to indicate wehther the Symbio Repository Elements should be exported default is true."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/bpmn/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"lcid","in":"query","schemaId":"schema_133"},{"name":"exportRepositoryElements","in":"query","schemaId":"schema_134"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/{storagecollection}/{tenant}/_api/v1/bpmn/{id}","href":"bpmn-api-(version-1)/bpmnv1_export","openApiOperationId":"BpmnV1_Export","summary":"Creates BPML XML definition for the given element."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"BPMN crated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":"Unable get BPMN."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bpmn-api-(version-1)/bpmnv1_export"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/bpmn/{id}"},{"label":"Imports the given BPMN posted to this endpoint.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/bpmn-api-(version-1)/bpmnv1_import","routeSlug":"/cpm/developer/openapi/openapi/bpmn-api-(version-1)/bpmnv1_import","metadata":{"seo":{"title":"Imports the given BPMN posted to this endpoint.","description":"Imports the given BPMN posted to this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BpmnV1_Import","name":"Imports the given BPMN posted to this endpoint.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Imports the given BPMN posted to this endpoint.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lcid","in":"query","schemaId":"schema_133","description":"The lcid to export the bpmn in. 0 as default, will use default data culture of the context."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/{storagecollection}/{tenant}/_api/v1/bpmn","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"lcid","in":"query","schemaId":"schema_133"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/{storagecollection}/{tenant}/_api/v1/bpmn","href":"bpmn-api-(version-1)/bpmnv1_import","openApiOperationId":"BpmnV1_Import","summary":"Imports the given BPMN posted to this endpoint."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Process imported.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}},"schemaId":"components/schemas/ModelCollectionOfElement"},{"code":"400","description":"Unable to import BPMN."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1bpmn/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModelCollectionOfElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bpmn-api-(version-1)/bpmnv1_import"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/bpmn"}],"content":{"contentType":"group","meta":{"name":"BPMN API (Version 1)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BPMN API (Version 1)","showPageActions":true},{"nodeType":"markdoc","content":"By using this API you can generate an BPML file for a given process."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{storagecollection}/{tenant}/_api/v1/bpmn/{id}","summary":"Creates BPML XML definition for the given element.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bpmn-api-(version-1)/bpmnv1_export","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/bpmn","summary":"Imports the given BPMN posted to this endpoint.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bpmn-api-(version-1)/bpmnv1_import","deprecated":false}]}]}]}]}},{"type":"group","label":"BPMN API (Version 2)","link":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)","routeSlug":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)","items":[{"label":"Creates BPML XML definition for the given element.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)/bpmnv2_export","routeSlug":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)/bpmnv2_export","metadata":{"seo":{"title":"Creates BPML XML definition for the given element.","description":"Creates BPML XML definition for the given element."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BpmnV2_Export","name":"Creates BPML XML definition for the given element.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates BPML XML definition for the given element.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The origin key of the element to export.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"lcid","in":"query","schemaId":"schema_133","description":"The lcid to export the bpmn in. 0 as default, will use default data culture of the context."},{"name":"exportRepositoryElements","in":"query","schemaId":"schema_134","description":"Boolean to indicate wehther the Symbio Repository Elements should be exported default is true."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v2/bpmn/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"lcid","in":"query","schemaId":"schema_133"},{"name":"exportRepositoryElements","in":"query","schemaId":"schema_134"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/{storagecollection}/{tenant}/_api/v2/bpmn/{id}","href":"bpmn-api-(version-2)/bpmnv2_export","openApiOperationId":"BpmnV2_Export","summary":"Creates BPML XML definition for the given element."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"BPMN crated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}},"schemaId":"schema_132"},{"code":"400","description":"Unable get BPMN."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_132","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_132"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bpmn-api-(version-2)/bpmnv2_export"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v2/bpmn/{id}"},{"label":"Imports the given BPMN posted to this endpoint, used to import new process for updating existing process use the Put method.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)/bpmnv2_import","routeSlug":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)/bpmnv2_import","metadata":{"seo":{"title":"Imports the given BPMN posted to this endpoint, used to import new process for updating existing process use the Put method.","description":"Imports the given BPMN posted to this endpoint, used to import new process for updating existing process use the Put method."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BpmnV2_Import","name":"Imports the given BPMN posted to this endpoint, used to import new process for updating existing process use the Put method.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Imports the given BPMN posted to this endpoint, used to import new process for updating existing process use the Put method.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cancel-on-parent-notFound","in":"query","schemaId":"schema_136","description":"If true, the import will be canceled if the specified parent element is not found. Defaults to false."},{"name":"foreign-ID","in":"query","schemaId":"schema_132","description":"The foreign Id of the process (the id from an external system). Used to identify a process for updates."},{"name":"Lcid","in":"query","schemaId":"schema_137","description":"The locale ID (LCID) to use for the import. Defaults to the context's default data culture."},{"name":"parent-id","in":"query","schemaId":"schema_132","description":"The ID of the parent element under which the new BPMN process will be imported."},{"name":"process-container-ID","in":"query","schemaId":"schema_132","description":"The container Id of the process to update."},{"name":"process-name","in":"query","schemaId":"schema_132","description":"The name to be assigned to the created process. If not specified, the file name is used as a fallback."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_138"}},"schemaId":"schema_138","pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/{storagecollection}/{tenant}/_api/v2/bpmn","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"cancel-on-parent-notFound","in":"query","schemaId":"schema_136"},{"name":"foreign-ID","in":"query","schemaId":"schema_132"},{"name":"Lcid","in":"query","schemaId":"schema_137"},{"name":"parent-id","in":"query","schemaId":"schema_132"},{"name":"process-container-ID","in":"query","schemaId":"schema_132"},{"name":"process-name","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_138"}},"responseCodes":["200","400","500"],"pointer":"/{storagecollection}/{tenant}/_api/v2/bpmn","href":"bpmn-api-(version-2)/bpmnv2_import","openApiOperationId":"BpmnV2_Import","summary":"Imports the given BPMN posted to this endpoint, used to import new process for updating existing process use the Put method."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"schemaId":"schema_138","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_138"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Process imported successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}},"schemaId":"components/schemas/ModelCollectionOfElement"},{"code":"400","description":"Unable to import BPMN."},{"code":"500","description":"Unable to update BPMN due to internal server error."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModelCollectionOfElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bpmn-api-(version-2)/bpmnv2_import"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v2/bpmn"},{"label":"Update the given BPMN process, process will by identifed by the processContainerID then foreignID if not found will return.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)/bpmnv2_update","routeSlug":"/cpm/developer/openapi/openapi/bpmn-api-(version-2)/bpmnv2_update","metadata":{"seo":{"title":"Update the given BPMN process, process will by identifed by the processContainerID then foreignID if not found will return.","description":"Update the given BPMN process, process will by identifed by the processContainerID then foreignID if not found will return."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"BpmnV2_Update","name":"Update the given BPMN process, process will by identifed by the processContainerID then foreignID if not found will return.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the given BPMN process, process will by identifed by the processContainerID then foreignID if not found will return.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cancel-on-parent-notFound","in":"query","schemaId":"schema_136","description":"If true, the import will be canceled if the specified parent element is not found. Defaults to false."},{"name":"foreign-ID","in":"query","schemaId":"schema_132","description":"The foreign Id of the process (the id from an external system). Used to identify a process for updates."},{"name":"Lcid","in":"query","schemaId":"schema_137","description":"The locale ID (LCID) to use for the import. Defaults to the context's default data culture."},{"name":"parent-id","in":"query","schemaId":"schema_132","description":"The ID of the parent element under which the new BPMN process will be imported."},{"name":"process-container-ID","in":"query","schemaId":"schema_132","description":"The container Id of the process to update."},{"name":"process-name","in":"query","schemaId":"schema_132","description":"The name to be assigned to the created process. If not specified, the file name is used as a fallback."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_138"}},"schemaId":"schema_138","pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/{storagecollection}/{tenant}/_api/v2/bpmn","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"cancel-on-parent-notFound","in":"query","schemaId":"schema_136"},{"name":"foreign-ID","in":"query","schemaId":"schema_132"},{"name":"Lcid","in":"query","schemaId":"schema_137"},{"name":"parent-id","in":"query","schemaId":"schema_132"},{"name":"process-container-ID","in":"query","schemaId":"schema_132"},{"name":"process-name","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_138"}},"responseCodes":["200","400","500"],"pointer":"/{storagecollection}/{tenant}/_api/v2/bpmn","href":"bpmn-api-(version-2)/bpmnv2_update","openApiOperationId":"BpmnV2_Update","summary":"Update the given BPMN process, process will by identifed by the processContainerID then foreignID if not found will return."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"schemaId":"schema_138","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_138"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Process updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}},"schemaId":"components/schemas/ModelCollectionOfElement"},{"code":"400","description":"Unable to update BPMN."},{"code":"500","description":"Unable to update BPMN due to internal server error."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1bpmn/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModelCollectionOfElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}}},{"code":"400"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bpmn-api-(version-2)/bpmnv2_update"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v2/bpmn"}],"content":{"contentType":"group","meta":{"name":"BPMN API (Version 2)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BPMN API (Version 2)","showPageActions":true},{"nodeType":"markdoc","content":"By using this API you can generate a BPMN file for a given process."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{storagecollection}/{tenant}/_api/v2/bpmn/{id}","summary":"Creates BPML XML definition for the given element.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bpmn-api-(version-2)/bpmnv2_export","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v2/bpmn","summary":"Imports the given BPMN posted to this endpoint, used to import new process for updating existing process use the Put method.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bpmn-api-(version-2)/bpmnv2_import","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v2/bpmn","summary":"Update the given BPMN process, process will by identifed by the processContainerID then foreignID if not found will return.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bpmn-api-(version-2)/bpmnv2_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Data API (Version 1)","link":"/cpm/developer/openapi/openapi/data-api-(version-1)","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-1)","items":[{"label":"Delete the element with the specified id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_delete","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_delete","metadata":{"seo":{"title":"Delete the element with the specified id","description":"Delete the element with the specified id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV1_Delete","name":"Delete the element with the specified id","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the element with the specified id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The id of the element.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["204","404"],"pointer":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}","href":"data-api-(version-1)/datav1_delete","openApiOperationId":"DataV1_Delete","summary":"Delete the element with the specified id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Element successfully deleted."},{"code":"404","description":"Element not found."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-1)/datav1_delete"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}"},{"label":"Gets the element with the specified id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_getbyid","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_getbyid","metadata":{"seo":{"title":"Gets the element with the specified id","description":"Gets the element with the specified id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV1_GetById","name":"Gets the element with the specified id","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the element with the specified id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The id of the element.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Expand","in":"query","schemaId":"schema_139","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names of related contexts to expand. If expanded the attributes of elements of a related context will be included in the response. Use '_all' to expand all related contexts."},"children":[]}]}]}]},{"name":"Facet","in":"query","schemaId":"schema_132","description":"The name of the facet to query."},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140","description":"Determines whether the root path should be included in the response."},{"name":"Lcid","in":"query","schemaId":"schema_141","description":"The LCIDs used to fetch the attribute values. Leave empty to use all available LCIDs."},{"name":"Resources","in":"query","schemaId":"schema_139","description":"The resources to include in the response, i.e. 'attributes', 'related', 'children', 'content'. Leave empty to include all available resources."},{"name":"Select","in":"query","schemaId":"schema_139","description":"The names of resource items to include in the response, i.e. 'name', 'authors' . Leave empty to include all available items."},{"name":"View","in":"query","schemaId":"schema_132","description":"The name of the view to query."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"Expand","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Facet","in":"query","schemaId":"schema_132"},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140"},{"name":"Lcid","in":"query","schemaId":"schema_141","style":"form","explode":true},{"name":"Resources","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Select","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"View","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}","href":"data-api-(version-1)/datav1_getbyid","openApiOperationId":"DataV1_GetById","summary":"Gets the element with the specified id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"404","description":"Element not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"404","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-1)/datav1_getbyid"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}"},{"label":"Gets all elements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_get","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_get","metadata":{"seo":{"title":"Gets all elements","description":"Gets all elements"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV1_Get","name":"Gets all elements","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all elements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Expand","in":"query","schemaId":"schema_139","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names of related contexts to expand. If expanded the attributes of elements of a related context will be included in the response. Use '_all' to expand all related contexts."},"children":[]}]}]}]},{"name":"Facet","in":"query","schemaId":"schema_132","description":"The name of the facet to query."},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140","description":"Determines whether the root path should be included in the response."},{"name":"Lcid","in":"query","schemaId":"schema_141","description":"The LCIDs used to fetch the attribute values. Leave empty to use all available LCIDs."},{"name":"Resources","in":"query","schemaId":"schema_139","description":"The resources to include in the response, i.e. 'attributes', 'related', 'children', 'content'. Leave empty to include all available resources."},{"name":"Select","in":"query","schemaId":"schema_139","description":"The names of resource items to include in the response, i.e. 'name', 'authors' . Leave empty to include all available items."},{"name":"View","in":"query","schemaId":"schema_132","description":"The name of the view to query."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/data/elements","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"Expand","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Facet","in":"query","schemaId":"schema_132"},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140"},{"name":"Lcid","in":"query","schemaId":"schema_141","style":"form","explode":true},{"name":"Resources","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Select","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"View","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/{storagecollection}/{tenant}/_api/v1/data/elements","href":"data-api-(version-1)/datav1_get","openApiOperationId":"DataV1_Get","summary":"Gets all elements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}},"schemaId":"components/schemas/ModelCollectionOfElement"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModelCollectionOfElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-1)/datav1_get"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/data/elements"},{"label":"Creates the posted element.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_post","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-1)/datav1_post","metadata":{"seo":{"title":"Creates the posted element.","description":"Creates the posted element."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV1_Post","name":"Creates the posted element.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates the posted element.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parentId","in":"query","schemaId":"schema_132","description":"The optional id of the parent."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element","pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/post/requestBody","description":"The element to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/{storagecollection}/{tenant}/_api/v1/data/elements","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"parentId","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Element"}},"responseCodes":["200","400","401","404"],"pointer":"/{storagecollection}/{tenant}/_api/v1/data/elements","href":"data-api-(version-1)/datav1_post","openApiOperationId":"DataV1_Post","summary":"Creates the posted element."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Element"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"400","description":"Element Could not be created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"401","description":"The user has no rights to perform the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"404","description":"Parent element not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1data~1elements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"400","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"401","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"404","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-1)/datav1_post"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/data/elements"}],"content":{"contentType":"group","meta":{"name":"Data API (Version 1)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data API (Version 1)","showPageActions":true},{"nodeType":"markdoc","content":"By using this API you can get, create, update and delete elements in Symbio."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}","summary":"Delete the element with the specified id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-api-(version-1)/datav1_delete","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/data/elements/{id}","summary":"Gets the element with the specified id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-api-(version-1)/datav1_getbyid","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/data/elements","summary":"Gets all elements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-api-(version-1)/datav1_get","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/data/elements","summary":"Creates the posted element.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-api-(version-1)/datav1_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Data API (Version 2)","link":"/cpm/developer/openapi/openapi/data-api-(version-2)","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-2)","items":[{"label":"Delete the element with the specified id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_delete","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_delete","metadata":{"seo":{"title":"Delete the element with the specified id","description":"Delete the element with the specified id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV2_Delete","name":"Delete the element with the specified id","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the element with the specified id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The id of the element.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["204","404"],"pointer":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}","href":"data-api-(version-2)/datav2_delete","openApiOperationId":"DataV2_Delete","summary":"Delete the element with the specified id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Element successfully deleted."},{"code":"404","description":"Element not found."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-2)/datav2_delete"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}"},{"label":"Gets the element with the specified id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_getbyid","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_getbyid","metadata":{"seo":{"title":"Gets the element with the specified id","description":"Gets the element with the specified id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV2_GetById","name":"Gets the element with the specified id","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the element with the specified id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The id of the element.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Expand","in":"query","schemaId":"schema_139","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names of related contexts to expand. If expanded the attributes of elements of a related context will be included in the response. Use '_all' to expand all related contexts."},"children":[]}]}]}]},{"name":"Facet","in":"query","schemaId":"schema_132","description":"The name of the facet to query."},{"name":"Filter","in":"query","schemaId":"schema_132","description":"The filter. e. g. name -eq 'symbio'"},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140","description":"Determines whether the root path should be included in the response."},{"name":"Lcid","in":"query","schemaId":"schema_141","description":"The LCIDs used to fetch the attribute values. Leave empty to use all available LCIDs."},{"name":"OrderBy","in":"query","schemaId":"schema_132","description":"The order by expression, e. g. name asc, purpose desc"},{"name":"Page","in":"query","schemaId":"schema_142","description":"The page. The default value is 1."},{"name":"PageSelectionKey","in":"query","schemaId":"schema_132","description":"The selected element id. If no page is specified, the page containing this selected element will be returned."},{"name":"PageSize","in":"query","schemaId":"schema_142","description":"The page size.The default value is 50."},{"name":"Resources","in":"query","schemaId":"schema_139","description":"The resources to include in the response, i.e. 'attributes', 'related', 'children', 'content'. Leave empty to include all available resources."},{"name":"Select","in":"query","schemaId":"schema_139","description":"The names of resource items to include in the response, i.e. 'name', 'authors' . Leave empty to include all available items."},{"name":"View","in":"query","schemaId":"schema_132","description":"The name of the view to query."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"Expand","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Facet","in":"query","schemaId":"schema_132"},{"name":"Filter","in":"query","schemaId":"schema_132"},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140"},{"name":"Lcid","in":"query","schemaId":"schema_141","style":"form","explode":true},{"name":"OrderBy","in":"query","schemaId":"schema_132"},{"name":"Page","in":"query","schemaId":"schema_142"},{"name":"PageSelectionKey","in":"query","schemaId":"schema_132"},{"name":"PageSize","in":"query","schemaId":"schema_142"},{"name":"Resources","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Select","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"View","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}","href":"data-api-(version-2)/datav2_getbyid","openApiOperationId":"DataV2_GetById","summary":"Gets the element with the specified id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"404","description":"Element not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"404","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-2)/datav2_getbyid"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}"},{"label":"Gets elements with pagination","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_get","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_get","metadata":{"seo":{"title":"Gets elements with pagination","description":"Gets elements with pagination"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV2_Get","name":"Gets elements with pagination","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets elements with pagination","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Expand","in":"query","schemaId":"schema_139","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The names of related contexts to expand. If expanded the attributes of elements of a related context will be included in the response. Use '_all' to expand all related contexts."},"children":[]}]}]}]},{"name":"Facet","in":"query","schemaId":"schema_132","description":"The name of the facet to query."},{"name":"Filter","in":"query","schemaId":"schema_132","description":"The filter. e. g. name -eq 'symbio'"},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140","description":"Determines whether the root path should be included in the response."},{"name":"Lcid","in":"query","schemaId":"schema_141","description":"The LCIDs used to fetch the attribute values. Leave empty to use all available LCIDs."},{"name":"OrderBy","in":"query","schemaId":"schema_132","description":"The order by expression, e. g. name asc, purpose desc"},{"name":"Page","in":"query","schemaId":"schema_142","description":"The page. The default value is 1."},{"name":"PageSelectionKey","in":"query","schemaId":"schema_132","description":"The selected element id. If no page is specified, the page containing this selected element will be returned."},{"name":"PageSize","in":"query","schemaId":"schema_142","description":"The page size.The default value is 50."},{"name":"Resources","in":"query","schemaId":"schema_139","description":"The resources to include in the response, i.e. 'attributes', 'related', 'children', 'content'. Leave empty to include all available resources."},{"name":"Select","in":"query","schemaId":"schema_139","description":"The names of resource items to include in the response, i.e. 'name', 'authors' . Leave empty to include all available items."},{"name":"View","in":"query","schemaId":"schema_132","description":"The name of the view to query."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v2/data/elements","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"Expand","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Facet","in":"query","schemaId":"schema_132"},{"name":"Filter","in":"query","schemaId":"schema_132"},{"name":"IncludeRootPath","in":"query","schemaId":"schema_140"},{"name":"Lcid","in":"query","schemaId":"schema_141","style":"form","explode":true},{"name":"OrderBy","in":"query","schemaId":"schema_132"},{"name":"Page","in":"query","schemaId":"schema_142"},{"name":"PageSelectionKey","in":"query","schemaId":"schema_132"},{"name":"PageSize","in":"query","schemaId":"schema_142"},{"name":"Resources","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"Select","in":"query","schemaId":"schema_139","style":"form","explode":true},{"name":"View","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/{storagecollection}/{tenant}/_api/v2/data/elements","href":"data-api-(version-2)/datav2_get","openApiOperationId":"DataV2_Get","summary":"Gets elements with pagination"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}},"schemaId":"components/schemas/ModelCollectionOfElement"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModelCollectionOfElement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfElement"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-2)/datav2_get"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v2/data/elements"},{"label":"Creates the posted element.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_post","routeSlug":"/cpm/developer/openapi/openapi/data-api-(version-2)/datav2_post","metadata":{"seo":{"title":"Creates the posted element.","description":"Creates the posted element."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataV2_Post","name":"Creates the posted element.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates the posted element.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parentId","in":"query","schemaId":"schema_132","description":"The optional id of the parent."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element","pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/post/requestBody","description":"The element to be created."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/{storagecollection}/{tenant}/_api/v2/data/elements","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"parentId","in":"query","schemaId":"schema_132"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Element"}},"responseCodes":["200","400","401","404"],"pointer":"/{storagecollection}/{tenant}/_api/v2/data/elements","href":"data-api-(version-2)/datav2_post","openApiOperationId":"DataV2_Post","summary":"Creates the posted element."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Element"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"400","description":"Element Could not be created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"401","description":"The user has no rights to perform the action.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"},{"code":"404","description":"Parent element not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}},"schemaId":"components/schemas/Element"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v2~1data~1elements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"400","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"401","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}},{"code":"404","schemaId":"components/schemas/Element","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Element"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-api-(version-2)/datav2_post"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v2/data/elements"}],"content":{"contentType":"group","meta":{"name":"Data API (Version 2)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data API (Version 2)","showPageActions":true},{"nodeType":"markdoc","content":"By using this API you can get data with pagination, and you can create, update and delete elements in Symbio."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}","summary":"Delete the element with the specified id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/data-api-(version-2)/datav2_delete","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v2/data/elements/{id}","summary":"Gets the element with the specified id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-api-(version-2)/datav2_getbyid","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v2/data/elements","summary":"Gets elements with pagination","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-api-(version-2)/datav2_get","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v2/data/elements","summary":"Creates the posted element.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-api-(version-2)/datav2_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Facets API (Version 1)","link":"/cpm/developer/openapi/openapi/facets-api-(version-1)","routeSlug":"/cpm/developer/openapi/openapi/facets-api-(version-1)","items":[{"label":"Returns all facet information.\nThe result can be filtered by specifying a facet kind (e. g. Business).","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/facets-api-(version-1)/facetsv1_get","routeSlug":"/cpm/developer/openapi/openapi/facets-api-(version-1)/facetsv1_get","metadata":{"seo":{"title":"Returns all facet information.\nThe result can be filtered by specifying a facet kind (e. g. Business).","description":"Returns all facet information.\nThe result can be filtered by specifying a facet kind (e. g. Business)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"FacetsV1_Get","name":"Returns all facet information.\nThe result can be filtered by specifying a facet kind (e. g. Business).","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns all facet information.\nThe result can be filtered by specifying a facet kind (e. g. Business).","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"Kind","in":"query","schemaId":"schema_143","description":"Facet kind (e. g. Business)"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/facets","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"Kind","in":"query","schemaId":"components/schemas/FacetTypeKind"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/{storagecollection}/{tenant}/_api/v1/facets","href":"facets-api-(version-1)/facetsv1_get","openApiOperationId":"FacetsV1_Get","summary":"Returns all facet information.\nThe result can be filtered by specifying a facet kind (e. g. Business)."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All facets will be returned, optionally filtered by the specified kind. The operation was successful."},{"code":"400","description":"Invalid request."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/facets-api-(version-1)/facetsv1_get"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/facets"},{"label":"Returns information about the facet with the specified identifier.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/facets-api-(version-1)/facetsv1_getbyid","routeSlug":"/cpm/developer/openapi/openapi/facets-api-(version-1)/facetsv1_getbyid","metadata":{"seo":{"title":"Returns information about the facet with the specified identifier.","description":"Returns information about the facet with the specified identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"FacetsV1_GetById","name":"Returns information about the facet with the specified identifier.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns information about the facet with the specified identifier.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The facet identifier","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/facets/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/{storagecollection}/{tenant}/_api/v1/facets/{id}","href":"facets-api-(version-1)/facetsv1_getbyid","openApiOperationId":"FacetsV1_GetById","summary":"Returns information about the facet with the specified identifier."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Information about requested facet will be returned. The operation was successful."},{"code":"400","description":"Invalid request."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1facets~1{id}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/facets-api-(version-1)/facetsv1_getbyid"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/facets/{id}"}],"content":{"contentType":"group","meta":{"name":"Facets API (Version 1)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Facets API (Version 1)","showPageActions":true},{"nodeType":"markdoc","content":"By using this API you can get information about facets in Symbio."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{storagecollection}/{tenant}/_api/v1/facets","summary":"Returns all facet information.\nThe result can be filtered by specifying a facet kind (e. g. Business).","prefix":{"name":"get","color":"get"},"badges":[],"link":"/facets-api-(version-1)/facetsv1_get","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/facets/{id}","summary":"Returns information about the facet with the specified identifier.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/facets-api-(version-1)/facetsv1_getbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"File API (Version 1)","link":"/cpm/developer/openapi/openapi/file-api-(version-1)","routeSlug":"/cpm/developer/openapi/openapi/file-api-(version-1)","items":[{"label":"Gets the content of the file with the specified id.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/file-api-(version-1)/filev1_getbyid","routeSlug":"/cpm/developer/openapi/openapi/file-api-(version-1)/filev1_getbyid","metadata":{"seo":{"title":"Gets the content of the file with the specified id.","description":"Gets the content of the file with the specified id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"FileV1_GetById","name":"Gets the content of the file with the specified id.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the content of the file with the specified id.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The id of the file.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fileProtocolKey","in":"query","schemaId":"schema_144","description":"The key of the file protocol to use, fall-back is \"StorageFileProtocol\"."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/file/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"fileProtocolKey","in":"query","schemaId":"schema_144"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","400","404"],"pointer":"/{storagecollection}/{tenant}/_api/v1/file/{id}","href":"file-api-(version-1)/filev1_getbyid","openApiOperationId":"FileV1_GetById","summary":"Gets the content of the file with the specified id."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadResponse"}},"schemaId":"components/schemas/FileUploadResponse"},{"code":"400","description":"Invalid file or protocol key."},{"code":"404","description":"File not found."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadResponse"}}},{"code":"400"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-api-(version-1)/filev1_getbyid"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/file/{id}"},{"label":"Uploads a file and\nreturns information about stored file.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/file-api-(version-1)/filev1_post","routeSlug":"/cpm/developer/openapi/openapi/file-api-(version-1)/filev1_post","metadata":{"seo":{"title":"Uploads a file and\nreturns information about stored file.","description":"Uploads a file and\nreturns information about stored file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"FileV1_Post","name":"Uploads a file and\nreturns information about stored file.","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Uploads a file and\nreturns information about stored file.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"mimeType","in":"query","schemaId":"schema_132","description":"The mime type of the file to store."},{"name":"fileName","in":"query","schemaId":"schema_132","description":"The file name without extension."},{"name":"fileProtocolKey","in":"query","schemaId":"schema_144","description":"The key of the file protocol to use, fall-back is \"StorageFileProtocol\"."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_145"}},"schemaId":"schema_145","pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file/post/requestBody","description":"The file to store."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/{storagecollection}/{tenant}/_api/v1/file","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"mimeType","in":"query","schemaId":"schema_132"},{"name":"fileName","in":"query","schemaId":"schema_132"},{"name":"fileProtocolKey","in":"query","schemaId":"schema_144"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_145"}},"responseCodes":["200","400"],"pointer":"/{storagecollection}/{tenant}/_api/v1/file","href":"file-api-(version-1)/filev1_post","openApiOperationId":"FileV1_Post","summary":"Uploads a file and\nreturns information about stored file."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"schemaId":"schema_145","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_145"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadResponse"}},"schemaId":"components/schemas/FileUploadResponse"},{"code":"400","description":"Invalid file or protocol key."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1file/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FileUploadResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FileUploadResponse"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-api-(version-1)/filev1_post"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/file"}],"content":{"contentType":"group","meta":{"name":"File API (Version 1)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File API (Version 1)","showPageActions":true},{"nodeType":"markdoc","content":"By using this API you can get, create, update and delete files in Symbio."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{storagecollection}/{tenant}/_api/v1/file/{id}","summary":"Gets the content of the file with the specified id.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-api-(version-1)/filev1_getbyid","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/file","summary":"Uploads a file and\nreturns information about stored file.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-api-(version-1)/filev1_post","deprecated":false}]}]}]}]}},{"type":"group","label":"Stereotypes API (Version 1)","link":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)","routeSlug":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)","items":[{"label":"Creates or updates the stereotype","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_createorupdate","routeSlug":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_createorupdate","metadata":{"seo":{"title":"Creates or updates the stereotype","description":"Creates or updates the stereotype"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"StereotypesV1_CreateOrUpdate","name":"Creates or updates the stereotype","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates or updates the stereotype","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"facet","in":"query","schemaId":"schema_146"},{"name":"view","in":"query","schemaId":"schema_147"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}},"schemaId":"components/schemas/StereotypeModel","pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/post/requestBody","description":"The stereotype model from body."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/{storagecollection}/{tenant}/_api/v1/stereotypes","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"facet","in":"query","schemaId":"schema_146"},{"name":"view","in":"query","schemaId":"schema_147"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}},"responseCodes":["200","201","400"],"pointer":"/{storagecollection}/{tenant}/_api/v1/stereotypes","href":"stereotypes-api-(version-1)/stereotypesv1_createorupdate","openApiOperationId":"StereotypesV1_CreateOrUpdate","summary":"Creates or updates the stereotype"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"schemaId":"components/schemas/StereotypeModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Stereotype successfully updated.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}},"schemaId":"components/schemas/StereotypeModel"},{"code":"201","description":"Stereotype created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}},"schemaId":"components/schemas/StereotypeModel"},{"code":"400","description":"Unable to create or update stereotype."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StereotypeModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}}},{"code":"201","schemaId":"components/schemas/StereotypeModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stereotypes-api-(version-1)/stereotypesv1_createorupdate"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/stereotypes"},{"label":"Gets all stereotypes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_get","routeSlug":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_get","metadata":{"seo":{"title":"Gets all stereotypes","description":"Gets all stereotypes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"StereotypesV1_Get","name":"Gets all stereotypes","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all stereotypes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"facet","in":"query","schemaId":"schema_146"},{"name":"view","in":"query","schemaId":"schema_147"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/stereotypes","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[{"name":"facet","in":"query","schemaId":"schema_146"},{"name":"view","in":"query","schemaId":"schema_147"}],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/{storagecollection}/{tenant}/_api/v1/stereotypes","href":"stereotypes-api-(version-1)/stereotypesv1_get","openApiOperationId":"StereotypesV1_Get","summary":"Gets all stereotypes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfStereotypeModel"}},"schemaId":"components/schemas/ModelCollectionOfStereotypeModel"}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ModelCollectionOfStereotypeModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ModelCollectionOfStereotypeModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stereotypes-api-(version-1)/stereotypesv1_get"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/stereotypes"},{"label":"Delete the element with the specified identifier id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_delete","routeSlug":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_delete","metadata":{"seo":{"title":"Delete the element with the specified identifier id","description":"Delete the element with the specified identifier id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"StereotypesV1_Delete","name":"Delete the element with the specified identifier id","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the element with the specified identifier id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The id of the element.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["204","404"],"pointer":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}","href":"stereotypes-api-(version-1)/stereotypesv1_delete","openApiOperationId":"StereotypesV1_Delete","summary":"Delete the element with the specified identifier id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Stereotype successfully deleted."},{"code":"404","description":"Stereotype not found."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stereotypes-api-(version-1)/stereotypesv1_delete"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}"},{"label":"Gets the stereotype with the specified identifier id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_getbyid","routeSlug":"/cpm/developer/openapi/openapi/stereotypes-api-(version-1)/stereotypesv1_getbyid","metadata":{"seo":{"title":"Gets the stereotype with the specified identifier id","description":"Gets the stereotype with the specified identifier id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"StereotypesV1_GetById","name":"Gets the stereotype with the specified identifier id","isWebhook":false,"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the stereotype with the specified identifier id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_132","description":"The id or API name of the stereotype.","required":true},{"name":"storagecollection","in":"path","schemaId":"schema_132","required":true},{"name":"tenant","in":"path","schemaId":"schema_132","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"symbio-auth-token","in":"header","schemaId":"schema_135","description":"The symbio auth token.","required":true}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}","servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_132"},{"name":"storagecollection","in":"path","required":true,"schemaId":"schema_132"},{"name":"tenant","in":"path","required":true,"schemaId":"schema_132"}],"query":[],"querystring":[],"header":[{"name":"symbio-auth-token","in":"header","required":true}],"cookie":[]},"security":[],"responseCodes":["200","404"],"pointer":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}","href":"stereotypes-api-(version-1)/stereotypesv1_getbyid","openApiOperationId":"StereotypesV1_GetById","summary":"Gets the stereotype with the specified identifier id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}},"schemaId":"components/schemas/StereotypeModel"},{"code":"404","description":"Stereotype not found."}],"pointer":"/paths/~1{storagecollection}~1{tenant}~1_api~1v1~1stereotypes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StereotypeModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StereotypeModel"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stereotypes-api-(version-1)/stereotypesv1_getbyid"}],"panels":[]}]},"httpPath":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}"}],"content":{"contentType":"group","meta":{"name":"Stereotypes API (Version 1)"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stereotypes API (Version 1)","showPageActions":true},{"nodeType":"markdoc","content":"By using this API you can get, create, update or delete stereotypes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/{storagecollection}/{tenant}/_api/v1/stereotypes","summary":"Creates or updates the stereotype","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stereotypes-api-(version-1)/stereotypesv1_createorupdate","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/stereotypes","summary":"Gets all stereotypes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stereotypes-api-(version-1)/stereotypesv1_get","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}","summary":"Delete the element with the specified identifier id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/stereotypes-api-(version-1)/stereotypesv1_delete","deprecated":false},{"title":"/{storagecollection}/{tenant}/_api/v1/stereotypes/{id}","summary":"Gets the stereotype with the specified identifier id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stereotypes-api-(version-1)/stereotypesv1_getbyid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Element":{"id":"components/schemas/Element","kind":"json-schema","title":"Element","data":{"type":"object","description":"Represents an element of Symbio (ProxyBase, mapped by RuleSet)","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the version-independent identifier of this element"},"properties":{"description":"Gets the properties of this Element.","$ref":"#/components/schemas/ElementProperties"}}}},"components/schemas/ElementProperties":{"id":"components/schemas/ElementProperties","kind":"json-schema","title":"ElementProperties","data":{"type":"object","description":"Properties of an Element.","additionalProperties":false,"properties":{"containerPermaLink":{"type":"string","description":"Gets or sets the version independent permanent URI for this element"},"creationId":{"type":"string","description":"Gets or sets the creation id."},"facetName":{"type":"string","description":"Gets or sets the name of the facet containing the element"},"parentId":{"type":"string","description":"Gets or sets the id of the parent element; null if no parent element exists."},"permaLink":{"type":"string","description":"Gets or sets the permanent URI for this element"},"state":{"type":"string","description":"Gets or sets the state of the element"},"stereoType":{"type":"string","description":"Gets or sets the stereotype of this element"},"type":{"type":"string","description":"Gets or sets the type of this element"},"versionId":{"type":"string","description":"Gets or sets the version-dependent identifier of this element"}}}},"components/schemas/CreateAuthTokenModel":{"id":"components/schemas/CreateAuthTokenModel","kind":"json-schema","title":"CreateAuthTokenModel","data":{"type":"object","description":"Model for the auth token creation.","additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the auth token"},"role":{"description":"Role of the auth token","$ref":"#/components/schemas/Role"},"permittedEverywhere":{"type":"boolean","description":"Defines if PermittedEverywhere should be set to the same date as Valid Until."}}}},"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"type":"integer","description":"Application roles","x-enumNames":["Access","Viewer","Editor","Approver","Analyzer","Architect","Administrator","Deactivated"],"enum":[0,1,2,4,8,16,32,-1]}},"components/schemas/AutomationParameters":{"id":"components/schemas/AutomationParameters","kind":"json-schema","title":"AutomationParameters","data":{"type":"object","description":"Parameter for executing an automation task with the AutomationV1Controller","additionalProperties":false}},"components/schemas/BasicCollectionOfBasicElement":{"id":"components/schemas/BasicCollectionOfBasicElement","kind":"json-schema","title":"BasicCollectionOfBasicElement","data":{"type":"object","description":"List of elements of type  in OData format","additionalProperties":false,"properties":{"value":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/BasicElement"}}}}},"components/schemas/BasicElement":{"id":"components/schemas/BasicElement","kind":"json-schema","title":"BasicElement","data":{"type":"object","description":"OData representation of an Symbio element","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the version-independent identifier (OriginKey) of this element"},"name":{"type":"string","description":"Gets or sets the name of this element"},"type":{"description":"Gets or sets the type of this element","$ref":"#/components/schemas/BasicTypeRef"},"stereotype":{"description":"Gets or sets the Stereotype of this element.","$ref":"#/components/schemas/BasicElementReference"},"state":{"description":"Gets or sets the release cycle state","$ref":"#/components/schemas/BasicTypeRef"},"createdBy":{"description":"Gets or sets the user who created this element","$ref":"#/components/schemas/BasicElementReference"},"createdOn":{"type":"string","description":"Gets or sets the date and time where this element was created.","format":"date-time"},"changedBy":{"description":"Gets or sets the user who changed this element","$ref":"#/components/schemas/BasicElementReference"},"changedOn":{"type":"string","description":"Gets or sets the date and time where this element was changed.","format":"date-time"},"description":{"type":"string","description":"Gets or sets the description"},"identifier":{"type":"string","description":"Gets or sets the identifier"},"uniqueIdentifier":{"type":"string","description":"Gets or sets the unique identifier"},"author":{"description":"Gets or sets the author","$ref":"#/components/schemas/BasicElementReference"},"responsible":{"description":"Gets or sets the responsible","$ref":"#/components/schemas/BasicElementReference"},"attributes":{"type":"object","description":"Gets or sets the attributes of this element","additionalProperties":{}},"relations":{"type":"object","description":"Gets or sets the one-to-one relations of this element","additionalProperties":{"$ref":"#/components/schemas/BasicElementReference"}}}}},"components/schemas/BasicTypeRef":{"id":"components/schemas/BasicTypeRef","kind":"json-schema","title":"BasicTypeRef","data":{"type":"object","description":"A class for API representation of a type reference.","additionalProperties":false,"properties":{"key":{"type":"string","description":"Gets or sets the key of this type."},"name":{"type":"string","description":"Gets or sets the display name of this type"}}}},"components/schemas/BasicElementReference":{"id":"components/schemas/BasicElementReference","kind":"json-schema","title":"BasicElementReference","data":{"type":"object","description":"OData representation of a reference to an Symbio element","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the version-independent identifier (OriginKey) of this element"},"name":{"type":"string","description":"Gets or sets the name of this element"}}}},"components/schemas/ModelCollectionOfElement":{"id":"components/schemas/ModelCollectionOfElement","kind":"json-schema","title":"ModelCollectionOfElement","data":{"type":"object","description":"Collection of models of type ","additionalProperties":false,"properties":{"count":{"type":"integer","description":"Gets the count of values","format":"int32"},"values":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/Element"}}}}},"components/schemas/CreateCollectionModel":{"id":"components/schemas/CreateCollectionModel","kind":"json-schema","title":"CreateCollectionModel","data":{"type":"object","description":"Class CreateCollectionModel.\nImplements the CollectionModel","additionalProperties":false,"properties":{"apiUrl":{"type":"string","description":"API URL of this collection."},"appUrl":{"type":"string","description":"App URL of this collection."},"baseId":{"type":"string","description":"Identifier of the base context."},"baseTenant":{"type":"string","description":"Base tenant identifier of this collection."},"dataCultures":{"type":"array","description":"Configured data cultures of this collection.","items":{"type":"integer","format":"int32"}},"defaultDataCulture":{"type":"integer","description":"Default data culture of this collection","format":"int32"},"description":{"type":"string","description":"Description of this collection."},"id":{"type":"string","description":"Identifier of this collection."},"isValid":{"type":"boolean","description":"True, if this collection is valid, otherwise false."},"mandatoryCultures":{"type":"array","description":"Mandatory data cultures of this collection.","items":{"type":"integer","format":"int32"}},"optionalCultures":{"type":"array","description":"Optional data cultures of this collection.","items":{"type":"integer","format":"int32"}},"pool":{"type":"string","description":"Pool where this collection is stored."},"region":{"description":"Region information of this collection.","$ref":"#/components/schemas/RegionInfo"},"tenant":{"type":"string","description":"Tenant identifier of this collection."},"timeZone":{"description":"Timezone information of this collection.","$ref":"#/components/schemas/TimeZoneInfo"},"title":{"type":"string","description":"Title of this collection."},"type":{"type":"string","description":"Type of this context."},"azureElasticPool":{"type":"string","description":"Gets or sets the Azure elastic pool."},"companyId":{"type":"string","description":"Gets or sets the company identifier."},"featureFlags":{"type":"array","description":"The feature flags that should be activated or deactivated after the creation of the collection.","items":{"$ref":"#/components/schemas/FeatureFlagModel"}}}}},"components/schemas/RegionInfo":{"id":"components/schemas/RegionInfo","kind":"json-schema","title":"RegionInfo","data":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"englishName":{"type":"string"},"displayName":{"type":"string"},"nativeName":{"type":"string"},"twoLetterISORegionName":{"type":"string"},"threeLetterISORegionName":{"type":"string"},"threeLetterWindowsRegionName":{"type":"string"},"isMetric":{"type":"boolean"},"geoId":{"type":"integer","format":"int32"},"currencyEnglishName":{"type":"string"},"currencyNativeName":{"type":"string"},"currencySymbol":{"type":"string"},"isoCurrencySymbol":{"type":"string"}}}},"components/schemas/TimeZoneInfo":{"id":"components/schemas/TimeZoneInfo","kind":"json-schema","title":"TimeZoneInfo","data":{"type":"object","additionalProperties":false,"properties":{"Id":{"type":"string"},"HasIanaId":{"type":"boolean"},"DisplayName":{"type":"string"},"StandardName":{"type":"string"},"DaylightName":{"type":"string"},"BaseUtcOffset":{"type":"string","format":"duration"},"SupportsDaylightSavingTime":{"type":"boolean"}}}},"components/schemas/FeatureFlagModel":{"id":"components/schemas/FeatureFlagModel","kind":"json-schema","title":"FeatureFlagModel","data":{"type":"object","description":"Model for feature flags in REST api.","additionalProperties":false,"properties":{"id":{"type":"string","description":"Feature flag Id"},"state":{"type":"string","description":"Feature flag state"}}}},"components/schemas/ModelCollectionOfCollectionModel":{"id":"components/schemas/ModelCollectionOfCollectionModel","kind":"json-schema","title":"ModelCollectionOfCollectionModel","data":{"type":"object","description":"Collection of models of type ","additionalProperties":false,"properties":{"count":{"type":"integer","description":"Gets the count of values","format":"int32"},"values":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/CollectionModel"}}}}},"components/schemas/CollectionModel":{"id":"components/schemas/CollectionModel","kind":"json-schema","title":"CollectionModel","data":{"type":"object","description":"Class CollectionModel.","additionalProperties":false,"properties":{"apiUrl":{"type":"string","description":"API URL of this collection."},"appUrl":{"type":"string","description":"App URL of this collection."},"baseId":{"type":"string","description":"Identifier of the base context."},"baseTenant":{"type":"string","description":"Base tenant identifier of this collection."},"dataCultures":{"type":"array","description":"Configured data cultures of this collection.","items":{"type":"integer","format":"int32"}},"defaultDataCulture":{"type":"integer","description":"Default data culture of this collection","format":"int32"},"description":{"type":"string","description":"Description of this collection."},"id":{"type":"string","description":"Identifier of this collection."},"isValid":{"type":"boolean","description":"True, if this collection is valid, otherwise false."},"mandatoryCultures":{"type":"array","description":"Mandatory data cultures of this collection.","items":{"type":"integer","format":"int32"}},"optionalCultures":{"type":"array","description":"Optional data cultures of this collection.","items":{"type":"integer","format":"int32"}},"pool":{"type":"string","description":"Pool where this collection is stored."},"region":{"description":"Region information of this collection.","$ref":"#/components/schemas/RegionInfo"},"tenant":{"type":"string","description":"Tenant identifier of this collection."},"timeZone":{"description":"Timezone information of this collection.","$ref":"#/components/schemas/TimeZoneInfo"},"title":{"type":"string","description":"Title of this collection."},"type":{"type":"string","description":"Type of this context."}}}},"components/schemas/ConsolidateRequest":{"id":"components/schemas/ConsolidateRequest","kind":"json-schema","title":"ConsolidateRequest","data":{"type":"object","description":"The consolidate request.","additionalProperties":false,"properties":{"secondaryIds":{"type":"array","description":"The element ids that will be used for the consolidation.","items":{"type":"string"}}}}},"components/schemas/DistributionStatus":{"id":"components/schemas/DistributionStatus","kind":"json-schema","title":"DistributionStatus","data":{"type":"object","description":"Distribution status to indicate whether a part of the distribution has finished and to retrieve the current log.","additionalProperties":false,"properties":{"finished":{"type":"boolean","description":"A value indicating whether the distribution has finished."},"logs":{"type":"string","description":"Gets all log entries of the distribution formatted as html."}}}},"components/schemas/DetailsModel":{"id":"components/schemas/DetailsModel","kind":"json-schema","title":"DetailsModel","data":{"type":"object","description":"The details model used for retrieving process or document information.","additionalProperties":false,"properties":{"reasonForRevision":{"type":"string","description":"The reason for revision."}}}},"components/schemas/ParticipantsInformationModel":{"id":"components/schemas/ParticipantsInformationModel","kind":"json-schema","title":"ParticipantsInformationModel","data":{"type":"object","description":"The model class for the training assistant data to be sent.","additionalProperties":false,"properties":{"responsible":{"description":"The responsible user of the queried element.","$ref":"#/components/schemas/Element"},"users":{"type":"array","description":"The users to be trained of the queried element.","items":{"$ref":"#/components/schemas/Element"}}}}},"components/schemas/SubscriptionInformationModel":{"id":"components/schemas/SubscriptionInformationModel","kind":"json-schema","title":"SubscriptionInformationModel","data":{"type":"object","description":"The model class for the subscription mail service","additionalProperties":false,"properties":{"localizedElementType":{"type":"object","description":"The localized element type of the element for which the subscribers are requested.","additionalProperties":{"type":"string"}},"responsible":{"description":"The responsible user of the element for which the subscribers are requested.","$ref":"#/components/schemas/Element"},"storageDefaultDataCultureLcid":{"type":"integer","description":"The LCID of the default data culture.","format":"int32"},"users":{"type":"array","description":"The users that are subscribed to the element.","items":{"$ref":"#/components/schemas/Element"}}}}},"components/schemas/FacetTypeKind":{"id":"components/schemas/FacetTypeKind","kind":"json-schema","title":"FacetTypeKind","data":{"type":"integer","description":"Kind of the facet type.","x-enumNames":["Default","Business","BusinessRelevant"],"enum":[0,1,2]}},"components/schemas/ModelCollectionOfFeatureFlagInfoModel":{"id":"components/schemas/ModelCollectionOfFeatureFlagInfoModel","kind":"json-schema","title":"ModelCollectionOfFeatureFlagInfoModel","data":{"type":"object","description":"Collection of models of type ","additionalProperties":false,"properties":{"count":{"type":"integer","description":"Gets the count of values","format":"int32"},"values":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/FeatureFlagInfoModel"}}}}},"components/schemas/FeatureFlagInfoModel":{"id":"components/schemas/FeatureFlagInfoModel","kind":"json-schema","title":"FeatureFlagInfoModel","data":{"type":"object","description":"Model for Feature Flag","additionalProperties":false,"properties":{"id":{"type":"string","description":"Feature flag Id"},"state":{"type":"string","description":"Feature flag state"},"dependsOn":{"type":"array","description":"Gets or sets the dependsOn of the Feature Flag","items":{"type":"string"}},"isOneway":{"type":"boolean","description":"Gets or sets the isOneway of the Feature Flag"},"names":{"type":"array","description":"Gets or sets the names of the Feature Flag","items":{"$ref":"#/components/schemas/FeatureName"}},"possibleStates":{"type":"array","description":"Gets or sets the possibleStates of the Feature Flag","items":{"type":"string"}}}}},"components/schemas/FeatureName":{"id":"components/schemas/FeatureName","kind":"json-schema","title":"FeatureName","data":{"type":"object","description":"Model for the Feature Flags Names","additionalProperties":false,"properties":{"lcid":{"type":"integer","description":"Gets or sets the lcid of the Feature Flag name","format":"int32"},"value":{"type":"string","description":"Gets or sets the value of the Feature Flag name value"}}}},"components/schemas/FileUploadResponse":{"id":"components/schemas/FileUploadResponse","kind":"json-schema","title":"FileUploadResponse","data":{"type":"object","description":"The structure, that represents the file upload response on success.","additionalProperties":false,"properties":{"contentType":{"type":"string","description":"The file content type/mime type."},"id":{"type":"string","description":"The file identifier/origin key."},"location":{"type":"string","description":"The file location."},"name":{"type":"string","description":"The name of the file."},"owner":{"type":"string","description":"The file owner's origin key."}}}},"components/schemas/GraphicServiceRoot":{"id":"components/schemas/GraphicServiceRoot","kind":"json-schema","title":"GraphicServiceRoot","data":{"type":"object","description":"Represents an element of Symbio (ProxyBase, mapped by RuleSet)","additionalProperties":false,"properties":{"result":{"type":"string","description":"Gets or sets the requested result format."},"calculation":{"type":"string","description":"States, which calculation style is requested, \"flow\", \"corona\", \"detailed\";"},"configurations":{"type":"array","description":"Gets the configuration.","items":{"$ref":"#/components/schemas/GraphicServiceConfiguration"}},"context":{"description":"The context element, usually the diagram.","$ref":"#/components/schemas/Element"},"content":{"description":"Gets the content.","$ref":"#/components/schemas/GraphicServiceContent"},"messageFlows":{"type":"array","description":"Gets the list of message flows.","items":{"$ref":"#/components/schemas/GraphicServiceElement"}},"pools":{"type":"array","description":"Gets the list of pools.","items":{"$ref":"#/components/schemas/GraphicServiceElement"}},"lanes":{"type":"array","description":"Gets the list of (ordered) lanes.","items":{"$ref":"#/components/schemas/GraphicServiceLaneInfo"}},"elements":{"type":"array","description":"Gets the list of contained elements.","items":{"$ref":"#/components/schemas/GraphicServiceElement"}}}}},"components/schemas/GraphicServiceConfiguration":{"id":"components/schemas/GraphicServiceConfiguration","kind":"json-schema","title":"GraphicServiceConfiguration","data":{"type":"object","description":"Properties of an GraphicServiceElement.","additionalProperties":false,"properties":{"laneRelevant":{"type":"array","description":"Currently containg the keys (api names) of the lane relevant properties (e.g. \"responsible\").","items":{"type":"string"}},"layoutType":{"type":"string","description":"The layout type."},"lcid":{"type":"integer","description":"The Lcid the attributes should be resolved in.","format":"int32"},"scale":{"type":"integer","description":"The scale.","format":"int32"},"vertical":{"type":"boolean","description":"Indicates, if the diagram is viewed in vertical orientation.\n            "}}}},"components/schemas/GraphicServiceContent":{"id":"components/schemas/GraphicServiceContent","kind":"json-schema","title":"GraphicServiceContent","data":{"type":"object","description":"Represents the content section of the JSON request format for the graphic service.","additionalProperties":false,"properties":{"nodes":{"type":"array","description":"The nodes (on shape basis).","items":{"$ref":"#/components/schemas/GraphicServiceContentNode"}},"edges":{"type":"array","description":"The edges (on shape basis).","items":{"$ref":"#/components/schemas/GraphicServiceContentEdge"}}}}},"components/schemas/GraphicServiceContentNode":{"id":"components/schemas/GraphicServiceContentNode","kind":"json-schema","title":"GraphicServiceContentNode","data":{"type":"object","description":"Represents a content section node of the JSON request format for the graphic service.","additionalProperties":false,"properties":{"shapeId":{"type":"string","description":"The shape id."},"elementId":{"type":"string","description":"The element id (container id, if element is versionable)."},"properties":{"description":"The properties collection for content section nodes.","$ref":"#/components/schemas/GraphicServiceContentNodeProperties"}}}},"components/schemas/GraphicServiceContentNodeProperties":{"id":"components/schemas/GraphicServiceContentNodeProperties","kind":"json-schema","title":"GraphicServiceContentNodeProperties","data":{"type":"object","description":"Represents a content section node's properties of the JSON request format for the graphic service.","additionalProperties":false,"properties":{"visibility":{"description":"The visibility.","$ref":"#/components/schemas/VisibilityState"},"type":{"type":"string","description":"The type."},"orthogonalSynchronizing":{"type":"string","description":"Gets or sets additional orthogonal synchronization layout information, that can only be determined from a BPMN import."},"pool":{"description":"Gets or sets the associated pool element's id (origin key).","$ref":"#/components/schemas/PoolIdElement"},"weight":{"type":"integer","description":"The weight (in sense of gravity) of the element.","format":"int32"}}}},"components/schemas/VisibilityState":{"id":"components/schemas/VisibilityState","kind":"json-schema","title":"VisibilityState","data":{"type":"integer","description":"Enum to specify graphic service content node visibility.","x-enumNames":["Active","Inactive","Cut"],"enum":[0,1,2]}},"components/schemas/PoolIdElement":{"id":"components/schemas/PoolIdElement","kind":"json-schema","title":"PoolIdElement","data":{"type":"object","description":"Simple class representing an pool id element.","additionalProperties":false,"properties":{"poolId":{"type":"string","description":"The pool id (origin key)."}}}},"components/schemas/GraphicServiceContentEdge":{"id":"components/schemas/GraphicServiceContentEdge","kind":"json-schema","title":"GraphicServiceContentEdge","data":{"type":"object","description":"Represents a content section edge of the JSON request format for the graphic service.","additionalProperties":false,"properties":{"shapeId":{"type":"string","description":"The shape id."},"elementId":{"type":"string","description":"The element id (container id, if element is versionable)."},"properties":{"description":"The properties collection for content section edges.","$ref":"#/components/schemas/GraphicServiceContentEdgeProperties"}}}},"components/schemas/GraphicServiceContentEdgeProperties":{"id":"components/schemas/GraphicServiceContentEdgeProperties","kind":"json-schema","title":"GraphicServiceContentEdgeProperties","data":{"type":"object","description":"Represents a content section edge's properties of the JSON request format for the graphic service.","additionalProperties":false,"properties":{"visibility":{"description":"The visibility.","$ref":"#/components/schemas/VisibilityState"},"type":{"type":"string","description":"The type."},"edgeMode":{"description":"Get or sets the edge mode.","$ref":"#/components/schemas/DiagonalState"},"source":{"description":"Gets or sets the source (predecessor).","$ref":"#/components/schemas/ShapeIdElement"},"target":{"description":"Gets or sets the target (successor).","$ref":"#/components/schemas/ShapeIdElement"}}}},"components/schemas/DiagonalState":{"id":"components/schemas/DiagonalState","kind":"json-schema","title":"DiagonalState","data":{"type":"integer","description":"The state of the edge routing handling.\nTOOD: May be renamed.","x-enumNames":["Orthogonal","Diagonal","Curvy"],"enum":[0,1,2]}},"components/schemas/ShapeIdElement":{"id":"components/schemas/ShapeIdElement","kind":"json-schema","title":"ShapeIdElement","data":{"type":"object","description":"A simple class representing an element with a shape id.","additionalProperties":false,"properties":{"shapeId":{"type":"string","description":"The shape id (origin key)."}}}},"components/schemas/GraphicServiceElement":{"id":"components/schemas/GraphicServiceElement","kind":"json-schema","title":"GraphicServiceElement","data":{"type":"object","description":"Represents an element of Symbio (ProxyBase, mapped by RuleSet)","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the version-independent identifier of this element"},"versionId":{"type":"string","description":"Gets or sets the version-dependent identifier of this element"},"properties":{"description":"Gets the properties of this GraphicServiceElement.","$ref":"#/components/schemas/GraphicServiceElementProperties"}}}},"components/schemas/GraphicServiceElementProperties":{"id":"components/schemas/GraphicServiceElementProperties","kind":"json-schema","title":"GraphicServiceElementProperties","data":{"type":"object","description":"Properties of an GraphicServiceElement.","additionalProperties":false,"properties":{"bpmnMarker":{"type":"string","description":"The BPMN marker."},"bpmnType":{"type":"string","description":"The BPMN type."},"kind":{"description":"Gets or sets the item kind.","nullable":true,"$ref":"#/components/schemas/ElementKind"},"messageVisibleKind":{"type":"string","description":"Gets or sets the visible kind of a message-flow."},"orthogonalSynchronizing":{"type":"string","description":"Gets or sets additional orthogonal synchronization layout information, that can only be determined from a BPMN import."},"stereoType":{"type":"string","description":"Gets or sets the stereo type of this element."},"type":{"type":"string","description":"Gets or sets the type of this element."},"typeDisplayName":{"type":"string","description":"Gets or sets the display name of type of this element."}}}},"components/schemas/ElementKind":{"id":"components/schemas/ElementKind","kind":"json-schema","title":"ElementKind","data":{"type":"integer","description":"The kind of graphic service element.","x-enumNames":["Object","Connection"],"enum":[0,1]}},"components/schemas/GraphicServiceLaneInfo":{"id":"components/schemas/GraphicServiceLaneInfo","kind":"json-schema","title":"GraphicServiceLaneInfo","data":{"type":"object","description":"The graphic service lane info object.","additionalProperties":false,"properties":{"layoutType":{"type":"string","description":"The layout type."},"lanes":{"type":"array","description":"The relevant lanes for the layout type.","items":{"$ref":"#/components/schemas/GraphicServiceLane"}}}}},"components/schemas/GraphicServiceLane":{"id":"components/schemas/GraphicServiceLane","kind":"json-schema","title":"GraphicServiceLane","data":{"type":"object","description":"The graphic service lane object.","additionalProperties":false,"properties":{"laneRelevantElementId":{"type":"string","description":"The lane relevant element id, \"DEFAULT\" in case of default lane."}}}},"components/schemas/BasicHierarchyNode":{"id":"components/schemas/BasicHierarchyNode","kind":"json-schema","title":"BasicHierarchyNode","data":{"type":"object","description":"Basic hierarchy object","additionalProperties":false,"properties":{"key":{"type":"string","description":"The key of the element in the hierarchy"},"children":{"type":"array","description":"The children of the current element","items":{"$ref":"#/components/schemas/BasicHierarchyNode"}}}}},"components/schemas/ModelCollectionOfOpsServiceFeatureFlagV1InfoModel":{"id":"components/schemas/ModelCollectionOfOpsServiceFeatureFlagV1InfoModel","kind":"json-schema","title":"ModelCollectionOfOpsServiceFeatureFlagV1InfoModel","data":{"type":"object","description":"Collection of models of type ","additionalProperties":false,"properties":{"count":{"type":"integer","description":"Gets the count of values","format":"int32"},"values":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/OpsServiceFeatureFlagV1InfoModel"}}}}},"components/schemas/OpsServiceFeatureFlagV1InfoModel":{"id":"components/schemas/OpsServiceFeatureFlagV1InfoModel","kind":"json-schema","title":"OpsServiceFeatureFlagV1InfoModel","data":{"type":"object","description":"Class OpsServiceFeatureFlagV1InfoModel.","additionalProperties":false,"properties":{"description":{"type":"string","description":"Gets or sets the description."},"id":{"type":"string","description":"Gets the identifier of the OpsService feature flag."},"internalDescription":{"type":"string","description":"Gets or sets the internal description."},"internalResourceUrl":{"type":"string","description":"Gets or sets the internal resource URL."},"name":{"type":"string","description":"Gets or sets the name."},"resourceUrl":{"type":"string","description":"Gets or sets the resource URL."},"usedByProductIds":{"type":"array","description":"Gets the identifiers of the products this feature flag is used by.","items":{"type":"string"}},"videoUrl":{"type":"string","description":"Gets or sets the video URL."}}}},"components/schemas/PermaLinkInfoModel":{"id":"components/schemas/PermaLinkInfoModel","kind":"json-schema","title":"PermaLinkInfoModel","data":{"type":"object","description":"The model class for permalink infos.","additionalProperties":false,"properties":{"canBeIndependentOfVersion":{"type":"boolean","description":"Gets a value indicating whether there can be a permalink independent of version."},"canBeOfSelectionInVersion":{"type":"boolean","description":"Gets a value indicating whether there can be a permalink of selection in version."},"canBeOfVersion":{"type":"boolean","description":"Gets a value indicating whether there can be a permalink of version."},"urlIndependentOfVersion":{"type":"string","description":"Gets the permalink URL independent of version."},"urlOfSelectionInVersion":{"type":"string","description":"Gets the permalink URL of selection in version."},"urlOfVersion":{"type":"string","description":"Gets the permalink URL of version."}}}},"components/schemas/PermaLinkCreationModel":{"id":"components/schemas/PermaLinkCreationModel","kind":"json-schema","title":"PermaLinkCreationModel","data":{"type":"object","description":"The model for perma link creation.","additionalProperties":false,"properties":{"linkType":{"type":"string","description":"Gets or sets the type of the link."}}}},"components/schemas/PowerPlatformElement":{"id":"components/schemas/PowerPlatformElement","kind":"json-schema","title":"PowerPlatformElement","data":{"type":"object","description":"OData representation of an Symbio element","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the version-independent identifier (OriginKey) of this element"},"name":{"type":"string","description":"Gets or sets the name of this element"},"typeKey":{"type":"string","description":"Gets or sets the type key of this element"},"typeName":{"type":"string","description":"Gets or sets the type name of this element"},"stereotypeId":{"type":"string","description":"Gets or sets the Stereotype identifier of this element."},"stereotypeName":{"type":"string","description":"Gets or sets the Stereotype name of this element."},"stateKey":{"type":"string","description":"Gets or sets the release cycle state key"},"stateName":{"type":"string","description":"Gets or sets the release cycle state name"},"createdById":{"type":"string","description":"Gets or sets the user identifier who created this element"},"createdByName":{"type":"string","description":"Gets or sets the user display name who created this element"},"createdOn":{"type":"string","description":"Gets or sets the date and time where this element was created.","format":"date-time"},"changedById":{"type":"string","description":"Gets or sets the user identifier who changed this element"},"changedByName":{"type":"string","description":"Gets or sets the user display name who changed this element"},"changedOn":{"type":"string","description":"Gets or sets the date and time where this element was changed.","format":"date-time"},"description":{"type":"string","description":"Gets or sets the description"},"identifier":{"type":"string","description":"Gets or sets the identifier"},"uniqueIdentifier":{"type":"string","description":"Gets or sets the unique identifier"},"authorId":{"type":"string","description":"Gets or sets the author identifier"},"authorName":{"type":"string","description":"Gets or sets the author name"},"responsibleId":{"type":"string","description":"Gets or sets the responsible identifier"},"responsibleName":{"type":"string","description":"Gets or sets the responsible name"},"properties":{"type":"object","description":"Gets or sets the attributes and relations of this element","additionalProperties":{}}}}},"components/schemas/PowerPlatformCollectionOfPowerPlatformElement":{"id":"components/schemas/PowerPlatformCollectionOfPowerPlatformElement","kind":"json-schema","title":"PowerPlatformCollectionOfPowerPlatformElement","data":{"type":"object","description":"List of elements of type  in OData format","additionalProperties":false,"properties":{"value":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/PowerPlatformElement"}}}}},"components/schemas/PowerPlatformElementAttributeChange":{"id":"components/schemas/PowerPlatformElementAttributeChange","kind":"json-schema","title":"PowerPlatformElementAttributeChange","data":{"type":"object","description":"Attribute to change an element using a key value pair","additionalProperties":false,"properties":{"key":{"type":"string","description":"The apiName of the attribute"},"lcid":{"type":"integer","description":"The Lcid of the attribute","format":"int32","nullable":true},"value":{"type":"string","description":"The value to be assigned to the attribute"}}}},"components/schemas/ConfiguredReportingModel":{"id":"components/schemas/ConfiguredReportingModel","kind":"json-schema","title":"ConfiguredReportingModel","data":{"type":"object","description":"Result model for the configured reporting.","additionalProperties":false,"properties":{"adminConnectionString":{"type":"string","description":"The administrative connection string will be used for DB operations and manipulations, e.g.the Fullfecth.DBO rights are required."},"collection":{"type":"string","description":"The identifier of the collection in which the storage to connect is."},"id":{"type":"string","description":"The identifier of the reporting pool."},"readerConnectionString":{"type":"string","description":"The read-only connection string will be used for read access by reports. Only read permissions are required."},"reportingService":{"description":"Configuration regarding the reporting service","$ref":"#/components/schemas/ReportingServiceConfiguration"},"storage":{"type":"string","description":"The identifier of the storage to connect."},"storageAuthToken":{"type":"string","description":"The auth token id from the connected storage."}}}},"components/schemas/ReportingServiceConfiguration":{"id":"components/schemas/ReportingServiceConfiguration","kind":"json-schema","title":"ReportingServiceConfiguration","data":{"type":"object","description":"The configuration of the reporting service.\nUsed in ConfigureReportingModel.","additionalProperties":false,"properties":{"token":{"type":"string","description":"The authentication token for the reporting service."},"url":{"type":"string","description":"Base url of the reporting service."}}}},"components/schemas/ConfigureReportingModel":{"id":"components/schemas/ConfigureReportingModel","kind":"json-schema","title":"ConfigureReportingModel","data":{"type":"object","description":"This model is used to configure the reporting.","additionalProperties":false,"properties":{"adminConnectionString":{"type":"string","description":"The administrative connection string will be used for DB operations and manipulations, e.g.the Fullfecth.DBO rights are required."},"collection":{"type":"string","description":"The identifier of the collection in which the storage to connect is."},"id":{"type":"string","description":"The identifier of the reporting pool."},"readerConnectionString":{"type":"string","description":"The read-only connection string will be used for read access by reports. Only read permissions are required."},"reportingService":{"description":"Configuration regarding the reporting service","$ref":"#/components/schemas/ReportingServiceConfiguration"},"storage":{"type":"string","description":"The identifier of the storage to connect."}}}},"components/schemas/Result":{"id":"components/schemas/Result","kind":"json-schema","title":"Result","data":{"type":"object","description":"Represents the result of a GET query to ReportingV1Controller.","additionalProperties":false,"properties":{"facet":{"type":"string","description":"Gets the queried facet."},"view":{"type":"string","description":"Gets the queried view."},"paging":{"description":"Gets the paging.","$ref":"#/components/schemas/PagingInfo"},"options":{"description":"Gets the options.","$ref":"#/components/schemas/Options"},"count":{"type":"integer","description":"Gets the count of elements returned in the Values property.","format":"int32"},"values":{"type":"array","description":"Gets the values the query returned.","items":{"$ref":"#/components/schemas/Element2"}},"timings":{"description":"Gets the timings.","$ref":"#/components/schemas/TimingDetails"},"errors":{"description":"Gets the error details.","$ref":"#/components/schemas/ErrorDetails"}}}},"components/schemas/PagingInfo":{"id":"components/schemas/PagingInfo","kind":"json-schema","title":"PagingInfo","data":{"type":"object","description":"Holds info about paging request and result.","additionalProperties":false,"properties":{"page":{"type":"integer","description":"Gets the page.","format":"int64"},"pageSize":{"type":"integer","description":"Gets the size of the page.","format":"int64"},"totalCount":{"type":"integer","description":"Gets the total count.","format":"int64"}}}},"components/schemas/Options":{"id":"components/schemas/Options","kind":"json-schema","title":"Options","data":{"type":"object","description":"Options for collecting data.","additionalProperties":false,"properties":{"continueOnErrorWithDetails":{"type":"boolean","description":"Gets a value indicating whether the request should proceed after an error and log detailed error."},"excludeVersionsOfContent":{"type":"boolean","description":"If set to true, will ignore versions of content, if the element is fetched separately."},"expandContentElements":{"type":"boolean","description":"Gets or sets a value indicating whether Content will be expanded with Elements (true), otherwise with ElementRefs (false).\nWill be set to false in nested Element creation automatically to prevent possible endless recursions."},"expandRelatedElements":{"type":"boolean","description":"Gets or sets a value indicating whether Related will be expanded with Elements (true), otherwise with ElementRefs (false).\nWill be set to false in nested Element creation automatically to prevent possible endless recursions."},"ignoreContentOfContent":{"type":"boolean","description":"If set to true, the content evalution within any content element is skipped completely."},"imageFileHandling":{"description":"Gets or sets a value indictating how urls within html attributes are replaced.","$ref":"#/components/schemas/ImageFileHandling"},"lastVersionsOnly":{"type":"boolean","description":"Gets or sets a value indicating whether to return last versions only."},"masterVariantOnly":{"type":"boolean","description":"Gets or sets a value indicating whether to return the master variant only."},"withTimings":{"type":"boolean","description":"Gets a value indicating whether the result should be generated with detailed timings."}}}},"components/schemas/ImageFileHandling":{"id":"components/schemas/ImageFileHandling","kind":"json-schema","title":"ImageFileHandling","data":{"type":"integer","description":"Represents the different types of how images are handled.","x-enumNames":["Default","Embedded","Imagecache","ImagecacheRelativeToApp"],"enum":[0,1,2,3]}},"components/schemas/Element2":{"id":"components/schemas/Element2","kind":"json-schema","title":"Element2","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents an element returned by the ReportingV1Controller."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the element type supports versions this will be the element container"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the Versions property will contain the actual versions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the element type supports variants this will be the master variant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the Variants property will contain any additional variants that may exist."},"children":[]}]}]}]}],"additionalProperties":false,"properties":{"attributes":{"type":"object","description":"Gets or sets the attributes.","additionalProperties":{"$ref":"#/components/schemas/Attribute"}},"related":{"type":"object","description":"Gets the related.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Identifiable"}}},"content":{"type":"array","description":"Gets the content.","items":{"$ref":"#/components/schemas/Identifiable"}},"id":{"type":"string","description":"Gets or sets the identifier.\nID of element container (if versions and/or variants are supported),\nID of element otherwise."},"versionId":{"type":"string","description":"Gets or sets the version identifier.\nID of element version (if versions are supported and this is a version),\nID of element (if versions are not supported),\nNULL otherwise."},"creationId":{"type":"string","description":"Gets or sets the creation identifier.\nElements with no informations about supporting variants and versions\nwill have a CreationId set to the Id of another Element they have been copied from.\nThis is normally only the case for content elements like events and tasks."},"variantId":{"type":"string","description":"Gets or sets the variant identifier.\nID of version container (if variants are supported),\nNULL otherwise."},"variantDefinitionId":{"type":"string","description":"Gets or sets the variant definition identifier.\nID of connected variant definition (if variants are supported and this is not part of the master variant),\nNULL otherwise."},"ordering":{"type":"integer","description":"Gets the ordering, i.e. the z-index of the defining shape.\nOnly available for content.","format":"int32","nullable":true},"facet":{"type":"string","description":"Gets or sets the facet."},"type":{"type":"string","description":"Gets the type."},"stereotype":{"type":"string","description":"Gets or sets the stereotype."},"state":{"type":"string","description":"Gets or sets the state."},"permaLink":{"type":"string","description":"Gets or sets the PermaLink"},"containerPermaLink":{"type":"string","description":"Gets or sets the Container PermaLink"},"supportsVariants":{"type":"boolean","description":"Gets or sets a value indicating whether this element supports variants."},"isMasterVariant":{"type":"boolean","description":"Gets or sets whether this is the master variant.","nullable":true},"supportsVersions":{"type":"boolean","description":"Gets or sets a value indicating whether this element supports versions."},"versions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the versions, null if CanHaveVersions == false."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ElementVersion"}},"variants":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the variants, null if CanHaveVariants == false."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ElementVariant"}},"isRootNode":{"type":"boolean","description":"Gets or sets the is root node.","nullable":true},"rootPath":{"type":"array","description":"Gets or sets the root path.","items":{"$ref":"#/components/schemas/ElementRef"}},"children":{"type":"array","description":"Gets or sets the children.","items":{"$ref":"#/components/schemas/ElementRef"}}}}},"components/schemas/Attribute":{"id":"components/schemas/Attribute","kind":"json-schema","title":"Attribute","data":{"type":"object","description":"Holder of attribute data for JSON serialization.","additionalProperties":{}}},"components/schemas/Identifiable":{"id":"components/schemas/Identifiable","kind":"json-schema","title":"Identifiable","data":{"type":"object","description":"Base class holding IDs to identify elements.","x-abstract":true,"additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the identifier.\nID of element container (if versions and/or variants are supported),\nID of element otherwise."},"versionId":{"type":"string","description":"Gets or sets the version identifier.\nID of element version (if versions are supported and this is a version),\nID of element (if versions are not supported),\nNULL otherwise."},"creationId":{"type":"string","description":"Gets or sets the creation identifier.\nElements with no informations about supporting variants and versions\nwill have a CreationId set to the Id of another Element they have been copied from.\nThis is normally only the case for content elements like events and tasks."},"variantId":{"type":"string","description":"Gets or sets the variant identifier.\nID of version container (if variants are supported),\nNULL otherwise."},"variantDefinitionId":{"type":"string","description":"Gets or sets the variant definition identifier.\nID of connected variant definition (if variants are supported and this is not part of the master variant),\nNULL otherwise."},"ordering":{"type":"integer","description":"Gets the ordering, i.e. the z-index of the defining shape.\nOnly available for content.","format":"int32","nullable":true},"facet":{"type":"string","description":"Gets or sets the facet."},"type":{"type":"string","description":"Gets the type."},"stereotype":{"type":"string","description":"Gets or sets the stereotype."},"state":{"type":"string","description":"Gets or sets the state."},"permaLink":{"type":"string","description":"Gets or sets the PermaLink"},"containerPermaLink":{"type":"string","description":"Gets or sets the Container PermaLink"}}}},"components/schemas/ElementVersion":{"id":"components/schemas/ElementVersion","kind":"json-schema","title":"ElementVersion","data":{"type":"object","description":"Represents a version of an element.","additionalProperties":false,"properties":{"attributes":{"type":"object","description":"Gets or sets the attributes.","additionalProperties":{"$ref":"#/components/schemas/Attribute"}},"related":{"type":"object","description":"Gets the related.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Identifiable"}}},"content":{"type":"array","description":"Gets the content.","items":{"$ref":"#/components/schemas/Identifiable"}},"id":{"type":"string","description":"Gets or sets the identifier.\nID of element container (if versions and/or variants are supported),\nID of element otherwise."},"versionId":{"type":"string","description":"Gets or sets the version identifier.\nID of element version (if versions are supported and this is a version),\nID of element (if versions are not supported),\nNULL otherwise."},"creationId":{"type":"string","description":"Gets or sets the creation identifier.\nElements with no informations about supporting variants and versions\nwill have a CreationId set to the Id of another Element they have been copied from.\nThis is normally only the case for content elements like events and tasks."},"variantId":{"type":"string","description":"Gets or sets the variant identifier.\nID of version container (if variants are supported),\nNULL otherwise."},"variantDefinitionId":{"type":"string","description":"Gets or sets the variant definition identifier.\nID of connected variant definition (if variants are supported and this is not part of the master variant),\nNULL otherwise."},"ordering":{"type":"integer","description":"Gets the ordering, i.e. the z-index of the defining shape.\nOnly available for content.","format":"int32","nullable":true},"facet":{"type":"string","description":"Gets or sets the facet."},"type":{"type":"string","description":"Gets the type."},"stereotype":{"type":"string","description":"Gets or sets the stereotype."},"state":{"type":"string","description":"Gets or sets the state."},"permaLink":{"type":"string","description":"Gets or sets the PermaLink"},"containerPermaLink":{"type":"string","description":"Gets or sets the Container PermaLink"},"isMasterVariant":{"type":"boolean","description":"Gets or sets whether this is part of the master variant.","nullable":true}}}},"components/schemas/ElementVariant":{"id":"components/schemas/ElementVariant","kind":"json-schema","title":"ElementVariant","data":{"type":"object","description":"Represents a variant of an element.","additionalProperties":false,"properties":{"attributes":{"type":"object","description":"Gets or sets the attributes.","additionalProperties":{"$ref":"#/components/schemas/Attribute"}},"related":{"type":"object","description":"Gets the related.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Identifiable"}}},"content":{"type":"array","description":"Gets the content.","items":{"$ref":"#/components/schemas/Identifiable"}},"id":{"type":"string","description":"Gets or sets the identifier.\nID of element container (if versions and/or variants are supported),\nID of element otherwise."},"versionId":{"type":"string","description":"Gets or sets the version identifier.\nID of element version (if versions are supported and this is a version),\nID of element (if versions are not supported),\nNULL otherwise."},"creationId":{"type":"string","description":"Gets or sets the creation identifier.\nElements with no informations about supporting variants and versions\nwill have a CreationId set to the Id of another Element they have been copied from.\nThis is normally only the case for content elements like events and tasks."},"variantId":{"type":"string","description":"Gets or sets the variant identifier.\nID of version container (if variants are supported),\nNULL otherwise."},"variantDefinitionId":{"type":"string","description":"Gets or sets the variant definition identifier.\nID of connected variant definition (if variants are supported and this is not part of the master variant),\nNULL otherwise."},"ordering":{"type":"integer","description":"Gets the ordering, i.e. the z-index of the defining shape.\nOnly available for content.","format":"int32","nullable":true},"facet":{"type":"string","description":"Gets or sets the facet."},"type":{"type":"string","description":"Gets the type."},"stereotype":{"type":"string","description":"Gets or sets the stereotype."},"state":{"type":"string","description":"Gets or sets the state."},"permaLink":{"type":"string","description":"Gets or sets the PermaLink"},"containerPermaLink":{"type":"string","description":"Gets or sets the Container PermaLink"},"isMasterVariant":{"type":"boolean","description":"Gets or sets whether this is the master variant."},"supportsVersions":{"type":"boolean","description":"Gets or sets a value indicating whether this element supports versions."},"versions":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the versions, null if CanHaveVersions == false."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ElementVersion"}}}}},"components/schemas/ElementRef":{"id":"components/schemas/ElementRef","kind":"json-schema","title":"ElementRef","data":{"type":"object","description":"Represents a reference to an element/element variant/element version without the associated data.","additionalProperties":false,"properties":{"id":{"type":"string","description":"Gets or sets the identifier.\nID of element container (if versions and/or variants are supported),\nID of element otherwise."},"versionId":{"type":"string","description":"Gets or sets the version identifier.\nID of element version (if versions are supported and this is a version),\nID of element (if versions are not supported),\nNULL otherwise."},"creationId":{"type":"string","description":"Gets or sets the creation identifier.\nElements with no informations about supporting variants and versions\nwill have a CreationId set to the Id of another Element they have been copied from.\nThis is normally only the case for content elements like events and tasks."},"variantId":{"type":"string","description":"Gets or sets the variant identifier.\nID of version container (if variants are supported),\nNULL otherwise."},"variantDefinitionId":{"type":"string","description":"Gets or sets the variant definition identifier.\nID of connected variant definition (if variants are supported and this is not part of the master variant),\nNULL otherwise."},"ordering":{"type":"integer","description":"Gets the ordering, i.e. the z-index of the defining shape.\nOnly available for content.","format":"int32","nullable":true},"facet":{"type":"string","description":"Gets or sets the facet."},"type":{"type":"string","description":"Gets the type."},"stereotype":{"type":"string","description":"Gets or sets the stereotype."},"state":{"type":"string","description":"Gets or sets the state."},"permaLink":{"type":"string","description":"Gets or sets the PermaLink"},"containerPermaLink":{"type":"string","description":"Gets or sets the Container PermaLink"},"isReference":{"type":"boolean","description":"Gets a value indicating whether this instance is a reference."},"isRootNode":{"type":"boolean","description":"Gets or sets the is root node.","nullable":true}}}},"components/schemas/TimingDetails":{"id":"components/schemas/TimingDetails","kind":"json-schema","title":"TimingDetails","data":{"type":"object","description":"Class TimingDetails.","additionalProperties":false,"properties":{"absoluteTimings":{"type":"object","description":"The absolute timings","additionalProperties":{"type":"string","format":"duration"}},"accumulatedTimings":{"type":"object","description":"The accumulated timings","additionalProperties":{"type":"string","format":"duration"}}}}},"components/schemas/ErrorDetails":{"id":"components/schemas/ErrorDetails","kind":"json-schema","title":"ErrorDetails","data":{"type":"object","description":"Holds detail information on errors that occurred.","additionalProperties":false,"properties":{"Capacity":{"type":"integer","format":"int32"},"Count":{"type":"integer","format":"int32"},"Item":{"$ref":"#/components/schemas/ErrorDetailsInfo"},"_items":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetailsInfo"}},"_size":{"type":"integer","format":"int32"},"_version":{"type":"integer","format":"int32"}}}},"components/schemas/ErrorDetailsInfo":{"id":"components/schemas/ErrorDetailsInfo","kind":"json-schema","title":"ErrorDetailsInfo","data":{"type":"object","description":"Error details information.","additionalProperties":false,"properties":{"id":{"type":"string","description":"Origin key of the affected element."},"path":{"type":"string","description":"Which part of the element caused the error."},"message":{"type":"string","description":"More details about the error that has occurred."}}}},"components/schemas/PropertiesConfigResult":{"id":"components/schemas/PropertiesConfigResult","kind":"json-schema","title":"PropertiesConfigResult","data":{"type":"object","description":"Class PropertiesConfigResult.","additionalProperties":false,"properties":{"facetTypeConfigs":{"type":"object","description":"Gets or sets the facet type configs.","additionalProperties":{"$ref":"#/components/schemas/FacetTypeConfig"}}}}},"components/schemas/FacetTypeConfig":{"id":"components/schemas/FacetTypeConfig","kind":"json-schema","title":"FacetTypeConfig","data":{"type":"object","description":"Class FacetTypeConfig.","additionalProperties":false,"properties":{"elementTypeConfigs":{"type":"object","description":"Gets or sets the element type configs.","additionalProperties":{"$ref":"#/components/schemas/ElementTypeConfig"}}}}},"components/schemas/ElementTypeConfig":{"id":"components/schemas/ElementTypeConfig","kind":"json-schema","title":"ElementTypeConfig","data":{"type":"object","description":"Class ElementTypeConfig.","additionalProperties":false,"properties":{"propertyConfigs":{"type":"object","description":"Gets or sets the property configs.","additionalProperties":{"$ref":"#/components/schemas/PropertyConfig"}}}}},"components/schemas/PropertyConfig":{"id":"components/schemas/PropertyConfig","kind":"json-schema","title":"PropertyConfig","data":{"type":"object","description":"Class PropertyConfig.","additionalProperties":false,"properties":{"detailContentCategoryKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets or sets the API name of the key of the category this property config's group is located in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Symbio BM (GroupRef|GroupDefinition).GroupKey."},"children":[]}]}]}]},"detailContentGroupKey":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gets the API name of the detail content group this property config is located in."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Symbio BM (GroupRef|GroupDefinition).Key."},"children":[]}]}]}]},"detailContentOrdering":{"type":"integer","description":"Gets or sets the detail content ordering.","format":"int32","nullable":true},"detailContentShortKey":{"type":"string","description":"Gets or sets the detail content short key."},"isDetailContent":{"type":"boolean","description":"Gets or sets a value indicating whether this property config is contained in the detail content."},"isEditorDetailContent":{"type":"boolean","description":"Gets or sets a value indicating whether this property is visible to editors."},"isImage":{"type":"boolean","description":"Gets or sets a value indicating whether this property represents an image."},"isViewerDetailContent":{"type":"boolean","description":"Gets or sets a value indicating whether this property is visible to viewers."},"maximumTextLength":{"type":"integer","description":"Gets or sets the maximum length of the text.","format":"int32","nullable":true},"numberOfDecimalPlaces":{"type":"integer","description":"Gets or sets the number of decimal places.","format":"int32","nullable":true}}}},"components/schemas/ModelCollectionOfIViewConfiguration":{"id":"components/schemas/ModelCollectionOfIViewConfiguration","kind":"json-schema","title":"ModelCollectionOfIViewConfiguration","data":{"type":"object","description":"Collection of models of type ","additionalProperties":false,"properties":{"count":{"type":"integer","description":"Gets the count of values","format":"int32"},"values":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/IViewConfiguration"}}}}},"components/schemas/IViewConfiguration":{"id":"components/schemas/IViewConfiguration","kind":"json-schema","title":"IViewConfiguration","data":{"type":"object","x-abstract":true,"additionalProperties":false,"properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/ICategory"}},"facet":{"type":"string"},"isViewer":{"type":"boolean"},"lcid":{"type":"integer","format":"int32"},"type":{"type":"string"}}}},"components/schemas/ICategory":{"id":"components/schemas/ICategory","kind":"json-schema","title":"ICategory","data":{"type":"object","x-abstract":true,"additionalProperties":false,"properties":{"description":{"type":"string"},"displayName":{"type":"string"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/IGroup"}},"name":{"type":"string"},"tooltip":{"type":"string"}}}},"components/schemas/IGroup":{"id":"components/schemas/IGroup","kind":"json-schema","title":"IGroup","data":{"type":"object","x-abstract":true,"additionalProperties":false,"properties":{"description":{"type":"string"},"displayName":{"type":"string"},"name":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/IProperty"}},"tooltip":{"type":"string"}}}},"components/schemas/IProperty":{"id":"components/schemas/IProperty","kind":"json-schema","title":"IProperty","data":{"type":"object","x-abstract":true,"additionalProperties":false,"properties":{"attributeDataType":{"nullable":true,"$ref":"#/components/schemas/AttributeDataType"},"decimalPlaces":{"type":"integer","format":"int32","nullable":true},"description":{"type":"string"},"detailContentShortKey":{"type":"string"},"displayName":{"type":"string"},"indexField":{"type":"string"},"indexFieldType":{"type":"string"},"isAttribute":{"type":"boolean"},"isImage":{"type":"boolean"},"isRelated":{"type":"boolean"},"lowerLimit":{"type":"number","format":"float","nullable":true},"maximumTextLength":{"type":"integer","format":"int32","nullable":true},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"tooltip":{"type":"string"},"upperLimit":{"type":"number","format":"float","nullable":true}}}},"components/schemas/AttributeDataType":{"id":"components/schemas/AttributeDataType","kind":"json-schema","title":"AttributeDataType","data":{"type":"integer","description":"","x-enumNames":["Unknown","Boolean","Integer","Float","Date","Time","Timespan","Timestamp","MultiLineText","SingleLineText","SelectionValue","CombinedValue","ConstNameReturn","Html","LinksValue","Password","LinkedEntity","Email","PhoneNumber","FaxNumber","SkypeName","SipAddress","Color","MaskedText","SearchQuery","MultiSelectionValue","OrderedRelated","Related","Action","CustomData"],"enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,14,15,16,17,18,19,20,21,22,23,24,25,26,27,10001,10002,10003]}},"components/schemas/SelectionInfoV1Model":{"id":"components/schemas/SelectionInfoV1Model","kind":"json-schema","title":"SelectionInfoV1Model","data":{"type":"object","description":"A model class used by the actions of the SelectionInfoV1Controller controller.","additionalProperties":false,"properties":{"selectionKeys":{"type":"array","description":"Gets or sets the selection keys.","items":{"type":"string"}}}}},"components/schemas/StereotypeModel":{"id":"components/schemas/StereotypeModel","kind":"json-schema","title":"StereotypeModel","data":{"type":"object","description":"The model class for the stereotypes.","additionalProperties":false,"properties":{"externalId":{"type":"string","description":"Gets or sets the external Id attribute."},"id":{"type":"string","description":"Gets or sets the identifier of this element."},"isNotSelectable":{"type":"boolean","description":"Gets or sets a value determining if stereotype is selectable in the UI."},"names":{"type":"object","description":"Gets or sets the name attributes.","additionalProperties":{"type":"string"}},"setReadOnly":{"type":"boolean","description":"Gets or sets the set read only.","nullable":true},"type":{"type":"string","description":"Gets or sets the type of this element."}}}},"components/schemas/ModelCollectionOfStereotypeModel":{"id":"components/schemas/ModelCollectionOfStereotypeModel","kind":"json-schema","title":"ModelCollectionOfStereotypeModel","data":{"type":"object","description":"Collection of models of type ","additionalProperties":false,"properties":{"count":{"type":"integer","description":"Gets the count of values","format":"int32"},"values":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/StereotypeModel"}}}}},"components/schemas/CreateStorageModel":{"id":"components/schemas/CreateStorageModel","kind":"json-schema","title":"CreateStorageModel","data":{"type":"object","description":"A model class with information to create a new storage.","additionalProperties":false,"properties":{"apiUrl":{"type":"string","description":"API URL"},"appUrl":{"type":"string","description":"App URL"},"baseId":{"type":"string","description":"Gets the ID of the base context."},"baseTenant":{"type":"string","description":"Base tenant ID"},"dataCultures":{"type":"array","description":"Configured data cultures of the storage","items":{"type":"integer","format":"int32"}},"defaultDataCulture":{"type":"integer","description":"Default data culture of the storage","format":"int32"},"description":{"type":"string","description":"Description of the storage"},"id":{"type":"string","description":"Gets the ID of this storage"},"isValid":{"type":"boolean","description":"True, if the storage is valid, otherwise false."},"mandatoryCultures":{"type":"array","description":"Mandatory data cultures of the storage","items":{"type":"integer","format":"int32"}},"optionalCultures":{"type":"array","description":"Optional data cultures of the storage","items":{"type":"integer","format":"int32"}},"pool":{"type":"string","description":"Gets the Pool there this storage is stored."},"region":{"description":"Region information of the storage","$ref":"#/components/schemas/RegionInfo"},"templateId":{"type":"string","description":"Template used for storage"},"tenant":{"type":"string","description":"Tenant ID"},"timeZone":{"description":"Timezone information of the storage","$ref":"#/components/schemas/TimeZoneInfo"},"title":{"type":"string","description":"Title of the storage"},"type":{"type":"string","description":"Type of the storage context"},"usersLimit":{"type":"integer","description":"The valid users limit.","format":"int32","nullable":true},"validUntil":{"type":"string","description":"The date until the storage is valid. If the data is expired nobody has access to Symbio.","format":"date-time","nullable":true},"emailSettings":{"type":"string","description":"Email settings used for invitation mail, e. g. \"InviteUserToSymbioForFreeMail\""},"featureFlags":{"type":"array","description":"The feature flags that should be activated or deactivated after the creation of the storage.","items":{"$ref":"#/components/schemas/FeatureFlagModel"}},"users":{"type":"array","description":"The users that should be created in the new storage","items":{"$ref":"#/components/schemas/CreateUserModel"}}}}},"components/schemas/CreateUserModel":{"id":"components/schemas/CreateUserModel","kind":"json-schema","title":"CreateUserModel","data":{"type":"object","description":"Model for OAuth user creation.","additionalProperties":false,"properties":{"email":{"type":"string","description":"Email address of the user"},"firstname":{"type":"string","description":"First name of the user"},"lastname":{"type":"string","description":"Last name of the user"},"role":{"description":"Role of the user","$ref":"#/components/schemas/Role"},"type":{"type":"string","description":"Gets the type."}}}},"components/schemas/ModelCollectionOfStorageModel":{"id":"components/schemas/ModelCollectionOfStorageModel","kind":"json-schema","title":"ModelCollectionOfStorageModel","data":{"type":"object","description":"Collection of models of type ","additionalProperties":false,"properties":{"count":{"type":"integer","description":"Gets the count of values","format":"int32"},"values":{"type":"array","description":"Gets the values in this collection","items":{"$ref":"#/components/schemas/StorageModel"}}}}},"components/schemas/StorageModel":{"id":"components/schemas/StorageModel","kind":"json-schema","title":"StorageModel","data":{"type":"object","description":"Model of storages","additionalProperties":false,"properties":{"apiUrl":{"type":"string","description":"API URL"},"appUrl":{"type":"string","description":"App URL"},"baseId":{"type":"string","description":"Gets the ID of the base context."},"baseTenant":{"type":"string","description":"Base tenant ID"},"dataCultures":{"type":"array","description":"Configured data cultures of the storage","items":{"type":"integer","format":"int32"}},"defaultDataCulture":{"type":"integer","description":"Default data culture of the storage","format":"int32"},"description":{"type":"string","description":"Description of the storage"},"id":{"type":"string","description":"Gets the ID of this storage"},"isValid":{"type":"boolean","description":"True, if the storage is valid, otherwise false."},"mandatoryCultures":{"type":"array","description":"Mandatory data cultures of the storage","items":{"type":"integer","format":"int32"}},"optionalCultures":{"type":"array","description":"Optional data cultures of the storage","items":{"type":"integer","format":"int32"}},"pool":{"type":"string","description":"Gets the Pool there this storage is stored."},"region":{"description":"Region information of the storage","$ref":"#/components/schemas/RegionInfo"},"templateId":{"type":"string","description":"Template used for storage"},"tenant":{"type":"string","description":"Tenant ID"},"timeZone":{"description":"Timezone information of the storage","$ref":"#/components/schemas/TimeZoneInfo"},"title":{"type":"string","description":"Title of the storage"},"type":{"type":"string","description":"Type of the storage context"},"usersLimit":{"type":"integer","description":"The valid users limit.","format":"int32","nullable":true},"validUntil":{"type":"string","description":"The date until the storage is valid. If the data is expired nobody has access to Symbio.","format":"date-time","nullable":true}}}},"components/schemas/StorageCreatedModel":{"id":"components/schemas/StorageCreatedModel","kind":"json-schema","title":"StorageCreatedModel","data":{"type":"object","description":"Model of the responses generated by the StoragesV1Controller controller.","additionalProperties":false,"properties":{"apiUrl":{"type":"string","description":"API URL"},"appUrl":{"type":"string","description":"App URL"},"baseId":{"type":"string","description":"Gets the ID of the base context."},"baseTenant":{"type":"string","description":"Base tenant ID"},"dataCultures":{"type":"array","description":"Configured data cultures of the storage","items":{"type":"integer","format":"int32"}},"defaultDataCulture":{"type":"integer","description":"Default data culture of the storage","format":"int32"},"description":{"type":"string","description":"Description of the storage"},"id":{"type":"string","description":"Gets the ID of this storage"},"isValid":{"type":"boolean","description":"True, if the storage is valid, otherwise false."},"mandatoryCultures":{"type":"array","description":"Mandatory data cultures of the storage","items":{"type":"integer","format":"int32"}},"optionalCultures":{"type":"array","description":"Optional data cultures of the storage","items":{"type":"integer","format":"int32"}},"pool":{"type":"string","description":"Gets the Pool there this storage is stored."},"region":{"description":"Region information of the storage","$ref":"#/components/schemas/RegionInfo"},"templateId":{"type":"string","description":"Template used for storage"},"tenant":{"type":"string","description":"Tenant ID"},"timeZone":{"description":"Timezone information of the storage","$ref":"#/components/schemas/TimeZoneInfo"},"title":{"type":"string","description":"Title of the storage"},"type":{"type":"string","description":"Type of the storage context"},"usersLimit":{"type":"integer","description":"The valid users limit.","format":"int32","nullable":true},"validUntil":{"type":"string","description":"The date until the storage is valid. If the data is expired nobody has access to Symbio.","format":"date-time","nullable":true},"symbioAuthToken":{"type":"string","description":"Gets the auto provisioned Symbio Auth Token."}}}},"components/schemas/CreateStorageV3Model":{"id":"components/schemas/CreateStorageV3Model","kind":"json-schema","title":"CreateStorageV3Model","data":{"type":"object","description":"A model class with information to create a new storage. (Version 3)","additionalProperties":false,"properties":{"apiUrl":{"type":"string","description":"API URL"},"appUrl":{"type":"string","description":"App URL"},"baseId":{"type":"string","description":"Gets the ID of the base context."},"baseTenant":{"type":"string","description":"Base tenant ID"},"dataCultures":{"type":"array","description":"Configured data cultures of the storage","items":{"type":"integer","format":"int32"}},"defaultDataCulture":{"type":"integer","description":"Default data culture of the storage","format":"int32"},"description":{"type":"string","description":"Description of the storage"},"id":{"type":"string","description":"Gets the ID of this storage"},"isValid":{"type":"boolean","description":"True, if the storage is valid, otherwise false."},"mandatoryCultures":{"type":"array","description":"Mandatory data cultures of the storage","items":{"type":"integer","format":"int32"}},"optionalCultures":{"type":"array","description":"Optional data cultures of the storage","items":{"type":"integer","format":"int32"}},"pool":{"type":"string","description":"Gets the Pool there this storage is stored."},"region":{"description":"Region information of the storage","$ref":"#/components/schemas/RegionInfo"},"templateId":{"type":"string","description":"Template used for storage"},"tenant":{"type":"string","description":"Tenant ID"},"timeZone":{"description":"Timezone information of the storage","$ref":"#/components/schemas/TimeZoneInfo"},"title":{"type":"string","description":"Title of the storage"},"type":{"type":"string","description":"Type of the storage context"},"usersLimit":{"type":"integer","description":"The valid users limit.","format":"int32","nullable":true},"validUntil":{"type":"string","description":"The date until the storage is valid. If the data is expired nobody has access to Symbio.","format":"date-time","nullable":true},"azureElasticPool":{"type":"string","description":"Gets or sets the Azure elastic pool."},"companyId":{"type":"string","description":"Gets or sets the company identifier."},"emailSettings":{"type":"string","description":"Email settings used for invitation mail, e. g. \"InviteUserToSymbioForFreeMail\""},"featureFlags":{"type":"array","description":"The feature flags that should be activated or deactivated after the creation of the storage.","items":{"$ref":"#/components/schemas/FeatureFlagModel"}},"users":{"type":"array","description":"The users that should be created in the new storage","items":{"$ref":"#/components/schemas/CreateUserModel"}}}}},"components/schemas/WebHookCreationResponse":{"id":"components/schemas/WebHookCreationResponse","kind":"json-schema","title":"WebHookCreationResponse","data":{"type":"object","description":"gives a CreationResponse of the Webhook","additionalProperties":false,"properties":{"id":{"type":"string","description":"WebHook Id"},"url":{"type":"string","description":"Webhook Url"}}}},"components/schemas/WebHookModel":{"id":"components/schemas/WebHookModel","kind":"json-schema","title":"WebHookModel","data":{"type":"object","description":"Model for creating a WebHook","additionalProperties":false,"properties":{"activated":{"type":"boolean","description":"Gets or sets whether the hook is enabled"},"dataToSend":{"type":"string","description":"Gets or sets the type of data to request"},"event":{"type":"string","description":"Gets or sets the trigger for this webhook"},"eventVersion":{"type":"string","description":"Gets or sets the event version of the data"},"facet":{"type":"string","description":"Gets or sets the facet this webhook is valid for"},"format":{"type":"string","description":"Gets or sets the format of the data"},"headers":{"type":"string","description":"Gets or sets the headers for the webhook"},"method":{"type":"string","description":"Gets or sets the HTTP Method"},"name":{"type":"string","description":"Gets or sets the identifier for the webhook"},"state":{"type":"string","description":"Gets or sets the state this webhook applies to"},"type":{"type":"string","description":"Gets or sets the type this webhook is valid for"},"url":{"type":"string","description":"Gets or sets the request URL"}}}},"schema_132":{"kind":"json-schema","data":{"type":"string"},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"boolean","nullable":true},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"integer","format":"int32","nullable":true},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"object","properties":{"bpmnfile":{"type":"string","format":"binary"},"config":{"type":"string","format":"binary","nullable":true}}},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int32"}},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"nullable":true,"$ref":"#/components/schemas/FacetTypeKind"},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"string","default":"Storage"},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"string","format":"byte"},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"string","default":"stereotypes"},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"string","default":"full"},"id":"schema_147"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"/_mock/cpm/developer/openapi/openapi","isMockServer":true,"description":"Test Server"}]},"options":{"jsonSamplesExpandLevel":"all","schemasExpansionLevel":2,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"PHP"},{"lang":"Python"}]},"feedback":{"type":"comment","settings":{"label":"Share your feedback for this page.","submitText":"Your comment has been sent to our team!"}},"hideSidebar":true,"mockServer":{"url":"/_mock/cpm/developer/openapi/openapi","position":"replace","description":"Test Server","off":false,"strictExamples":false,"errorIfForcedExampleNotFound":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/cpm/developer/openapi/openapi.json?download"},{"url":"/_bundle/cpm/developer/openapi/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Symbio Business Manager","description":"Public API for Symbio Business Manager"}},"baseSlug":"/cpm/developer/openapi/openapi","routesMapping":{}}