Skip to content

Commit

Permalink
Revert "[PCF Exchange Kit] Kit Update Rel. 24.08"
Browse files Browse the repository at this point in the history
  • Loading branch information
maximilianong authored Jul 26, 2024
1 parent ad93e12 commit eec3396
Show file tree
Hide file tree
Showing 22 changed files with 3,414 additions and 1,779 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
id: catena-x-pcf-request-endpoint
title: "Catena-X-pcf-request-endpoint"
description: " A API for request, send and update PCF data"
sidebar_label: Introduction
sidebar_position: 0
hide_title: true
custom_edit_url: null
---

import ApiLogo from "@theme/ApiLogo";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiDemoPanel/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 1.1.0</span>

# Catena-X-pcf-request-endpoint


An API to request, send and update PCF data via the Catena-X Network.
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
id: get-pcf
title: "get_pcf"
description: "get_pcf"
sidebar_label: "get_pcf"
hide_title: true
hide_table_of_contents: true
api: {"operationId":"get_pcf","parameters":[{"name":"Edc-Bpn","description":"The caller's Catena-X BusinessPartnerNumber","example":"BPNL0000005AMPL3","in":"header","required":true,"schema":{"type":"string"}},{"name":"productId","description":"ID of the product/materiual the PCF is requested for","example":"urn:id:8534x67","in":"path","required":true,"schema":{"type":"string"}},{"name":"requestId","description":"ID identifying the call (will be referenced in corresponding PCF response)","example":"2daa49aa-ee16-4df3-bca3-69ddead40419","in":"query","required":true,"schema":{"type":"string"}},{"name":"message","in":"query","required":false,"description":"URL encoded, max 250 chars","example":"No%20offset%20included%2C%20please%21","schema":{"type":"string"}}],"responses":{"202":{"description":"PCF was accepted. PCF will be sent later via to POST endpoint."}},"description":"get_pcf","method":"get","path":"/productIds/{productId}","info":{"title":"Catena-X-pcf-request-endpoint","version":"1.1.0"},"postman":{"name":"get pcf","description":{"type":"text/plain"},"url":{"path":["productIds",":productId"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ID identifying the call (will be referenced in corresponding PCF response)","type":"text/plain"},"key":"requestId","value":""},{"disabled":false,"description":{"content":"URL encoded, max 250 chars","type":"text/plain"},"key":"message","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the product/materiual the PCF is requested for","type":"text/plain"},"type":"any","value":"","key":"productId"}]},"header":[{"disabled":false,"description":{"content":"(Required) The caller's Catena-X BusinessPartnerNumber","type":"text/plain"},"key":"Edc-Bpn","value":""}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: docs-kits/kits/PCF-Exchange-Kit/Software-Development-View/pcf-exchange-api//catena-x-pcf-request-endpoint
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";

## get_pcf



get_pcf

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"productId","description":"ID of the product/materiual the PCF is requested for","example":"urn:id:8534x67","in":"path","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"requestId","description":"ID identifying the call (will be referenced in corresponding PCF response)","example":"2daa49aa-ee16-4df3-bca3-69ddead40419","in":"query","required":true,"schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"message","in":"query","required":false,"description":"URL encoded, max 250 chars","example":"No%20offset%20included%2C%20please%21","schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Header Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"Edc-Bpn","description":"The caller's Catena-X BusinessPartnerNumber","example":"BPNL0000005AMPL3","in":"header","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"202"} value={"202"}><div>

PCF was accepted. PCF will be sent later via to POST endpoint.

</div><div></div></TabItem></ApiTabs></div>

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

35 changes: 0 additions & 35 deletions docs-kits/kits/PCF Exchange Kit/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,41 +11,6 @@ sidebar_position: 1

All notable changes to this Kit will be documented in this file.

## [1.2.0] - 2024-08-01

### Added

#### Adoption View

* References to available PCF exchange solutions (moved from CX-0136 PCF Use Case standard)
* Comprehensive illustration of latest PCF data model (overview plus details)

#### Development View

* Specification for bilateral contracts

### Changed

#### Adoption View

* Exemplary PCF data model payload to PCF data model version 7.0.0 (Rel. 24.08)
* References to relevant standards in their latest versions (Rel. 24.08)
* Several typos and link errors
* Reference to Framework Agreement

#### Development View

* PCF Exchange API to Rel. 24.08 (e.g. data format)
* Several illustrations to reflect latest changes in Rel. 24.08
* Policy adapted to latest standards (incl. new Framework Agreement and bilateral contracts)
* Referenced standard updated

### Removed

#### Development View

* Inlined Open-API (MDX) removed

## [1.1.0] - 2024-05-17

### Added
Expand Down
Loading

0 comments on commit eec3396

Please sign in to comment.