Skip to content

Commit

Permalink
docs: update BPDM kit R23.12
Browse files Browse the repository at this point in the history
  • Loading branch information
SujitMBRDI committed Nov 2, 2023
1 parent 6c5b574 commit 2f623a5
Show file tree
Hide file tree
Showing 55 changed files with 172 additions and 124 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Creates or updates a sharing state of a business partner"
sidebar_label: "Creates or updates a sharing state of a business partner"
hide_title: true
hide_table_of_contents: true
api: {"tags":["sharing-state-controller"],"operationId":"upsertSharingState","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"businessPartnerType":{"type":"string","description":"One of the types of business partners for which the sharing state entry was created.","enum":["LEGAL_ENTITY","SITE","ADDRESS"]},"externalId":{"type":"string","description":"The external identifier of the business partner for which the sharing state entry was created."},"sharingStateType":{"type":"string","description":"One of the sharing state types of the current sharing state.","enum":["Pending","Success","Error","Initial"]},"sharingErrorCode":{"type":"string","description":"One of the sharing error codes in case the current sharing state type is \"error\".","enum":["SharingProcessError","SharingTimeout","BpnNotInPool"]},"sharingErrorMessage":{"type":"string","description":"The error message in case the current sharing state type is \"error\"."},"bpn":{"type":"string","description":"The business partner number associated to the combination of external identifier and business partner type in case the sharing state type is “success”. Can be either a BPNL, BPNS or BPNA."},"sharingProcessStarted":{"type":"string","description":"The date and time when the sharing process was started.","format":"date-time"}},"description":"A sharing state entry shows the progress in the sharing process and is updated each time the progress for a business partner changes. The business partner is identified by a combination of external ID and business partner type."}}},"required":true},"responses":{"204":{"description":"Operation completed successfully"},"400":{"description":"Invalid data (e.g. external ID)"}},"description":"Creates or updates a sharing state of a business partner","method":"put","path":"/api/catena/sharing-state","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"businessPartnerType":"LEGAL_ENTITY","externalId":"string","sharingStateType":"Pending","sharingErrorCode":"SharingProcessError","sharingErrorMessage":"string","bpn":"string","sharingProcessStarted":"2023-10-17"},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.1.0-SNAPSHOT"},"postman":{"name":"Creates or updates a sharing state of a business partner","description":{"type":"text/plain"},"url":{"path":["api","catena","sharing-state"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
api: {"tags":["sharing-state-controller"],"operationId":"upsertSharingState","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"businessPartnerType":{"type":"string","description":"One of the types of business partners for which the sharing state entry was created.","enum":["LEGAL_ENTITY","SITE","ADDRESS","GENERIC"]},"externalId":{"type":"string","description":"The external identifier of the business partner for which the sharing state entry was created."},"sharingStateType":{"type":"string","description":"One of the sharing state types of the current sharing state.","enum":["Pending","Success","Error","Initial"]},"sharingErrorCode":{"type":"string","description":"One of the sharing error codes in case the current sharing state type is \"error\".","enum":["SharingProcessError","SharingTimeout","BpnNotInPool"]},"sharingErrorMessage":{"type":"string","description":"The error message in case the current sharing state type is \"error\"."},"bpn":{"type":"string","description":"The business partner number associated to the combination of external identifier and business partner type in case the sharing state type is “success”. Can be either a BPNL, BPNS or BPNA."},"sharingProcessStarted":{"type":"string","description":"The date and time when the sharing process was started.","format":"date-time"},"taskId":{"type":"string","description":"The orchestrator task identifier that was created"}},"description":"A sharing state entry shows the progress in the sharing process and is updated each time the progress for a business partner changes. The business partner is identified by a combination of external ID and business partner type."}}},"required":true},"responses":{"204":{"description":"Operation completed successfully"},"400":{"description":"Invalid data (e.g. external ID)"}},"description":"Creates or updates a sharing state of a business partner","method":"put","path":"/api/catena/sharing-state","servers":[{"url":"http://localhost:8081","description":"Generated server url"}],"jsonRequestBodyExample":{"businessPartnerType":"LEGAL_ENTITY","externalId":"string","sharingStateType":"Pending","sharingErrorCode":"SharingProcessError","sharingErrorMessage":"string","bpn":"string","sharingProcessStarted":"2023-11-02","taskId":"string"},"info":{"title":"Business Partner Data Management Gate","description":"A gate for a member to share business partner data with CatenaX","version":"4.1.0-SNAPSHOT"},"postman":{"name":"Creates or updates a sharing state of a business partner","description":{"type":"text/plain"},"url":{"path":["api","catena","sharing-state"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "put api-method"
info_path: docs-kits/kits/Business Partner Kit/Software Development View/Gate Api/business-partner-data-management-gate
custom_edit_url: null
Expand All @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem";

Creates or updates a sharing state of a business partner

<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><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"businessPartnerType"} required={false} deprecated={undefined} schemaDescription={"One of the types of business partners for which the sharing state entry was created."} schemaName={"string"} qualifierMessage={"**Possible values:** [`LEGAL_ENTITY`, `SITE`, `ADDRESS`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} deprecated={undefined} schemaDescription={"The external identifier of the business partner for which the sharing state entry was created."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingStateType"} required={false} deprecated={undefined} schemaDescription={"One of the sharing state types of the current sharing state."} schemaName={"string"} qualifierMessage={"**Possible values:** [`Pending`, `Success`, `Error`, `Initial`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingErrorCode"} required={false} deprecated={undefined} schemaDescription={"One of the sharing error codes in case the current sharing state type is \"error\"."} schemaName={"string"} qualifierMessage={"**Possible values:** [`SharingProcessError`, `SharingTimeout`, `BpnNotInPool`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingErrorMessage"} required={false} deprecated={undefined} schemaDescription={"The error message in case the current sharing state type is \"error\"."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"bpn"} required={false} deprecated={undefined} schemaDescription={"The business partner number associated to the combination of external identifier and business partner type in case the sharing state type is “success”. Can be either a BPNL, BPNS or BPNA."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingProcessStarted"} required={false} deprecated={undefined} schemaDescription={"The date and time when the sharing process was started."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"204"} value={"204"}><div>
<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><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"businessPartnerType"} required={false} deprecated={undefined} schemaDescription={"One of the types of business partners for which the sharing state entry was created."} schemaName={"string"} qualifierMessage={"**Possible values:** [`LEGAL_ENTITY`, `SITE`, `ADDRESS`, `GENERIC`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"externalId"} required={false} deprecated={undefined} schemaDescription={"The external identifier of the business partner for which the sharing state entry was created."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingStateType"} required={false} deprecated={undefined} schemaDescription={"One of the sharing state types of the current sharing state."} schemaName={"string"} qualifierMessage={"**Possible values:** [`Pending`, `Success`, `Error`, `Initial`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingErrorCode"} required={false} deprecated={undefined} schemaDescription={"One of the sharing error codes in case the current sharing state type is \"error\"."} schemaName={"string"} qualifierMessage={"**Possible values:** [`SharingProcessError`, `SharingTimeout`, `BpnNotInPool`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingErrorMessage"} required={false} deprecated={undefined} schemaDescription={"The error message in case the current sharing state type is \"error\"."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"bpn"} required={false} deprecated={undefined} schemaDescription={"The business partner number associated to the combination of external identifier and business partner type in case the sharing state type is “success”. Can be either a BPNL, BPNS or BPNA."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"sharingProcessStarted"} required={false} deprecated={undefined} schemaDescription={"The date and time when the sharing process was started."} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"taskId"} required={false} deprecated={undefined} schemaDescription={"The orchestrator task identifier that was created"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"204"} value={"204"}><div>

Operation completed successfully

Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Loading

0 comments on commit 2f623a5

Please sign in to comment.