diff --git a/docs/postman/EDC BPDM Consumer.postman_collection.json b/docs/postman/EDC BPDM Consumer.postman_collection.json index 77c27bbf5..727fcb213 100644 --- a/docs/postman/EDC BPDM Consumer.postman_collection.json +++ b/docs/postman/EDC BPDM Consumer.postman_collection.json @@ -49,7 +49,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 1,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:ReadAccessPoolForCatenaXMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n }\r\n ]\r\n }\r\n}", + "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 1,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:ReadAccessPoolForCatenaXMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/edc/v0.0.1/ns/BusinessPartnerNumber\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"{{CONSUMER_BPNL}}\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" @@ -107,7 +107,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 1,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:FullAccessGateInputForSharingMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/edc/v0.0.1/ns/BusinessPartnerNumber\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"{{CONSUMER_BPNL}}\"\r\n }\r\n ]\r\n }\r\n}", + "raw": "{\r\n \"@context\": {\r\n \"@vocab\": \"https://w3id.org/edc/v0.0.1/ns/\"\r\n },\r\n \"@type\": \"CatalogRequest\",\r\n \"counterPartyAddress\": \"{{PROVIDER_EDC_DATASPACE_API}}\",\r\n \"counterPartyId\": \"{{PROVIDER_BPNL}}\",\r\n \"protocol\": \"dataspace-protocol-http\",\r\n \"querySpec\": {\r\n \"offset\": 0,\r\n \"limit\": 10,\r\n \"filterExpression\": [\r\n {\r\n \"operandLeft\": \"https://purl.org/dc/terms/subject\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"cx-taxo:FullAccessGateInputForSharingMember\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/catenax/ontology/common/version\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"6.0\"\r\n },\r\n {\r\n \"operandLeft\": \"https://w3id.org/edc/v0.0.1/ns/BusinessPartnerNumber\",\r\n \"operator\": \"=\",\r\n \"operandRight\": \"{{CONSUMER_BPNL}}\"\r\n }\r\n ]\r\n }\r\n}", "options": { "raw": { "language": "json" @@ -3665,6 +3665,585 @@ ] } ] + }, + { + "name": "relation-controller", + "item": [ + { + "name": "/input/business-partner-relations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?externalIds=&externalIds=&relationType=&businessPartnerSourceExternalIds=&businessPartnerSourceExternalIds=&businessPartnerTargetExternalIds=&businessPartnerTargetExternalIds=&updatedAtFrom=&page=&size=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "externalIds", + "value": "", + "description": "Only show relations with the given external identifiers" + }, + { + "key": "externalIds", + "value": "", + "description": "Only show relations with the given external identifiers" + }, + { + "key": "relationType", + "value": "", + "description": "Only show relations of the given type" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as sources" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as sources" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as targets" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as targets" + }, + { + "key": "updatedAtFrom", + "value": "", + "description": "Only show relations which have been modified after the given time stamp" + }, + { + "key": "page", + "value": "", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "", + "description": "Size of each page" + } + ] + }, + "description": "Find paginated list of business partner relations from the input stage. There are various filter criteria available. All filters are 'AND' filters." + }, + "response": [ + { + "name": "A paginated list of business partner relations for the input stage", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?externalIds=&externalIds=&relationType=&businessPartnerSourceExternalIds=&businessPartnerSourceExternalIds=&businessPartnerTargetExternalIds=&businessPartnerTargetExternalIds=&updatedAtFrom=&page=&size=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "externalIds", + "value": "" + }, + { + "key": "externalIds", + "value": "" + }, + { + "key": "relationType", + "value": "" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "" + }, + { + "key": "updatedAtFrom", + "value": "" + }, + { + "key": "page", + "value": "" + }, + { + "key": "size", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } + ] + }, + { + "name": "/input/business-partner-relations", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?createIfNotExist=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "createIfNotExist", + "value": "", + "description": "If true a business partner relation will be created even if a relation could not be found under the given external identifier." + } + ] + }, + "description": "Update an existing business partner relation on the input stage. By using a request parameter it is also possible to create a relation if the relation with the given external identifier does not exist. " + }, + "response": [ + { + "name": "The given business partner relation has been updated.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?createIfNotExist=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "createIfNotExist", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\",\n \"updatedAt\": \"\"\n}" + }, + { + "name": "On wrong or insufficient user provided data like references to non-existent business partners or relations that violate the relation constraints. ", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?createIfNotExist=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "createIfNotExist", + "value": "" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"error\": [\n \"\",\n \"\"\n ],\n \"path\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\"\n}" + } + ] + }, + { + "name": "/input/business-partner-relations", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"relationType\": \"\",\n \"externalId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ] + }, + "description": "Create a new relation between two business partner entries on the input stage. The external identifier is optional and a new one will be automatically created if not given. A given external identifier has to be unique." + }, + "response": [ + { + "name": "The created business partner input relation", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"relationType\": \"\",\n \"externalId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ] + } + }, + "status": "Created", + "code": 201, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\",\n \"updatedAt\": \"\"\n}" + }, + { + "name": "If the business partner could not be created based on wrong or insufficient data provided such as non-existent business partners or violated relation constraints. ", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"relationType\": \"\",\n \"externalId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"error\": [\n \"\",\n \"\"\n ],\n \"path\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\"\n}" + }, + { + "name": "If a relation with the given external identifier already exists", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"relationType\": \"\",\n \"externalId\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"error\": [\n \"\",\n \"\"\n ],\n \"path\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\"\n}" + } + ] + }, + { + "name": "/input/business-partner-relations", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?externalId=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "externalId", + "value": "", + "description": "(Required) The external identifier of the business partner relation to delete" + } + ] + }, + "description": "Delete a relation between two business partners on the input stage." + }, + "response": [ + { + "name": "The specified relation has been deleted.", + "originalRequest": { + "method": "DELETE", + "header": [], + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?externalId=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "externalId", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/plain" + } + ], + "cookie": [], + "body": "" + }, + { + "name": "On specifying a relation that does not exist. ", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?externalId=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "externalId", + "value": "" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"error\": [\n \"\",\n \"\"\n ],\n \"path\": \"\",\n \"status\": \"\",\n \"timestamp\": \"\"\n}" + } + ] + } + ] } ], "auth": { @@ -4524,6 +5103,165 @@ ] } ] + }, + { + "name": "relation-controller", + "item": [ + { + "name": "/input/business-partner-relations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?externalIds=&externalIds=&relationType=&businessPartnerSourceExternalIds=&businessPartnerSourceExternalIds=&businessPartnerTargetExternalIds=&businessPartnerTargetExternalIds=&updatedAtFrom=&page=&size=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "externalIds", + "value": "", + "description": "Only show relations with the given external identifiers" + }, + { + "key": "externalIds", + "value": "", + "description": "Only show relations with the given external identifiers" + }, + { + "key": "relationType", + "value": "", + "description": "Only show relations of the given type" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as sources" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as sources" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as targets" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "", + "description": "Only show relations which have the given business partners as targets" + }, + { + "key": "updatedAtFrom", + "value": "", + "description": "Only show relations which have been modified after the given time stamp" + }, + { + "key": "page", + "value": "", + "description": "Number of page to get results from" + }, + { + "key": "size", + "value": "", + "description": "Size of each page" + } + ] + }, + "description": "Find paginated list of business partner relations from the input stage. There are various filter criteria available. All filters are 'AND' filters." + }, + "response": [ + { + "name": "A paginated list of business partner relations for the input stage", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/v6/input/business-partner-relations?externalIds=&externalIds=&relationType=&businessPartnerSourceExternalIds=&businessPartnerSourceExternalIds=&businessPartnerTargetExternalIds=&businessPartnerTargetExternalIds=&updatedAtFrom=&page=&size=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "v6", + "input", + "business-partner-relations" + ], + "query": [ + { + "key": "externalIds", + "value": "" + }, + { + "key": "externalIds", + "value": "" + }, + { + "key": "relationType", + "value": "" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "" + }, + { + "key": "businessPartnerSourceExternalIds", + "value": "" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "" + }, + { + "key": "businessPartnerTargetExternalIds", + "value": "" + }, + { + "key": "updatedAtFrom", + "value": "" + }, + { + "key": "page", + "value": "" + }, + { + "key": "size", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"content\": [\n {\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"businessPartnerSourceExternalId\": \"\",\n \"businessPartnerTargetExternalId\": \"\",\n \"createdAt\": \"\",\n \"externalId\": \"\",\n \"relationType\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"contentSize\": \"\",\n \"page\": \"\",\n \"totalElements\": \"\",\n \"totalPages\": \"\"\n}" + } + ] + } + ] } ], "auth": { diff --git a/docs/postman/EDC Provider Setup.postman_collection.json b/docs/postman/EDC Provider Setup.postman_collection.json index 3d99748ef..4ee21f73e 100644 --- a/docs/postman/EDC Provider Setup.postman_collection.json +++ b/docs/postman/EDC Provider Setup.postman_collection.json @@ -617,9 +617,14 @@ "value": "BPNL000000000001", "type": "string" }, + { + "key": "CONSUMER_NAME", + "value": "consumer-name", + "type": "string" + }, { "key": "CLIENT_ID_POOL_CX_MEMBER_READ", - "value": "CLIENT_1_ID", + "value": "CLIENT_2_ID", "type": "string" }, { @@ -654,7 +659,7 @@ }, { "key": "CLIENT_SECRET_PATH_GATE_SHARING_MEMBER_READ_OUTPUT", - "value": "vault/path/client/3/secret", + "value": "vault/path/client/4/secret", "type": "string" }, {