docs: DCM-Kit Content Release 24.03

docs-kits/kits/DCM-Kit/Software-Development-View/_category_.json

@@ -0,0 +1,4 @@
+{
+    "label": "Software Development View"
+}
+

docs-kits/kits/DCM-Kit/Software-Development-View/receive-comment-information.api.mdx

@@ -0,0 +1,62 @@
+---
+id: receive-comment-information
+title: "Receive comment information"
+description: "Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition."
+sidebar_label: "Receive comment information"
+hide_title: true
+hide_table_of_contents: true
+api: {"description":"Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition.","requestBody":{"description":"This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.","required":true,"content":{"application/json":{"schema":{"description":"Aspect model for an exchange of comment belonging to a entity.","type":"object","properties":{"commentId":{"description":"The Comment ID uniquely identifies the entity within the business relationship between a customer and its supplier.","type":"string","pattern":"(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)"},"objectId":{"description":"The ID of the object to which the comment belongs.","type":"string","pattern":"(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)"},"author":{"description":"The E-Mail address of the creator who wrote the comment. In case comment creator wants to stay anonymous, show BPNL in app which is sent the comment along.","type":"string"},"postedAt":{"description":"Point in time when the comment was created.","type":"string","format":"date-time"},"changedAt":{"description":"Point in time when the comment was last changed.","type":"string","format":"date-time"},"commentText":{"description":"Text up to 5.000 characters in format \"UTF-8\" will be shared.","type":"string","pattern":"^[\\s\\S]{0,5000}$"},"commentType":{"description":"Type of a comment to indicate a priority.","type":"string","enum":["information","warning","default","actionRequired"]},"requestDelete":{"description":"Indicates that the deletion of the comment is requested by sender incl. all of it's history.","type":"boolean"},"listOfReferenceDates":{"description":"Point in time the comment belongs to.","type":"array","items":{"type":"string","format":"date"},"uniqueItems":true},"objectType":{"description":"Aspect Model which the comment refers to. The value MUST consist of the Catena-X aspect model unique identifier of the referenced data model without a version.","type":"string"},"customer":{"description":"The Business Partner Number Legal Entity (BPNL) of the party requesting materials from a supplier.","type":"string","pattern":"^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"},"supplier":{"description":"The Business Partner Number Legal Entity (BPNL) of the party providing materials to a customer.","type":"string","pattern":"^BPNL[0-9]{8}[a-zA-Z0-9]{4}$"}},"required":["commentId","objectId","objectType","customer","supplier"]}}}},"tags":["IdBasedComment"],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"405":{"description":"Method not allowed"},"422":{"description":"Unprocessable Entity"},"503":{"description":"Service Unavailable"}},"method":"post","path":"/internal-dcm-application-comment-post-endpoint","jsonRequestBodyExample":{"commentId":"string","objectId":"string","author":"string","postedAt":"2024-02-13","changedAt":"2024-02-13","commentText":"string","commentType":"information","requestDelete":true,"listOfReferenceDates":["2024-02-13"],"objectType":"string","customer":"string","supplier":"string"},"info":{"title":"Id Based Comment","version":"v1"},"postman":{"name":"Receive comment information","description":{"content":"Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition.","type":"text/plain"},"url":{"path":["internal-dcm-application-comment-post-endpoint"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
+sidebar_class_name: "post api-method"
+info_path: docs-kits/kits/DCM-Kit/Software-Development-View//id-based-comment
+custom_edit_url: null
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import TabItem from "@theme/TabItem";
+
+## Receive comment information
+
+
+
+Endpoint of an internal application responsible for recieving comment information from a Catena-X partner. This endpoint must be called via EDC Asset definition.
+
+<MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
+
+This request body defines the payload with it's mandatory and optional properties that must be sent to this endpoint.
+
+</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"commentId"} required={true} deprecated={undefined} schemaDescription={"The Comment ID uniquely identifies the entity within the business relationship between a customer and its supplier."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} deprecated={undefined} schemaDescription={"The ID of the object to which the comment belongs."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"author"} required={false} deprecated={undefined} schemaDescription={"The E-Mail address of the creator who wrote the comment. In case comment creator wants to stay anonymous, show BPNL in app which is sent the comment along."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"postedAt"} required={false} deprecated={undefined} schemaDescription={"Point in time when the comment was created."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"changedAt"} required={false} deprecated={undefined} schemaDescription={"Point in time when the comment was last changed."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"commentText"} required={false} deprecated={undefined} schemaDescription={"Text up to 5.000 characters in format \"UTF-8\" will be shared."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^[\\s\\S]{0,5000}$`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"commentType"} required={false} deprecated={undefined} schemaDescription={"Type of a comment to indicate a priority."} schemaName={"string"} qualifierMessage={"**Possible values:** [`information`, `warning`, `default`, `actionRequired`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"requestDelete"} required={false} deprecated={undefined} schemaDescription={"Indicates that the deletion of the comment is requested by sender incl. all of it's history."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"listOfReferenceDates"} required={false} deprecated={undefined} schemaDescription={"Point in time the comment belongs to."} schemaName={"date[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={true} deprecated={undefined} schemaDescription={"Aspect Model which the comment refers to. The value MUST consist of the Catena-X aspect model unique identifier of the referenced data model without a version."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"customer"} required={true} deprecated={undefined} schemaDescription={"The Business Partner Number Legal Entity (BPNL) of the party requesting materials from a supplier."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^BPNL[0-9]{8}[a-zA-Z0-9]{4}$`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"supplier"} required={true} deprecated={undefined} schemaDescription={"The Business Partner Number Legal Entity (BPNL) of the party providing materials to a customer."} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `^BPNL[0-9]{8}[a-zA-Z0-9]{4}$`"} defaultValue={undefined}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
+
+OK
+
+</div><div></div></TabItem><TabItem label={"400"} value={"400"}><div>
+
+Bad request
+
+</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>
+
+Unauthorized
+
+</div><div></div></TabItem><TabItem label={"403"} value={"403"}><div>
+
+Forbidden
+
+</div><div></div></TabItem><TabItem label={"405"} value={"405"}><div>
+
+Method not allowed
+
+</div><div></div></TabItem><TabItem label={"422"} value={"422"}><div>
+
+Unprocessable Entity
+
+</div><div></div></TabItem><TabItem label={"503"} value={"503"}><div>
+
+Service Unavailable
+
+</div><div></div></TabItem></ApiTabs></div>
+