diff --git a/docs/README.md b/docs/README.md index b5e5b4b2..823a0af8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,9 +21,9 @@ # Introduction Following documentation is available: -| Documentation | Purpose | -|----------------------------------------------------------------------------|---------------------------------------------------------------------| -| [Arc42](architecture/) | Architecture documentation for the discovery finder. | -| [Guideline to use aws-cognito](guideline-aws-cognito-configuration.md) | Documentation to use aws cognito as identity provider | -| [Guideline to use edc-extension](guideline-edc-extension-configuration.md) | Documentation to build and use the edc extension for access control | -| [Development](development/) | Useful collections for development | \ No newline at end of file +| Documentation | Purpose | +|----------------------------------------------------------------------------|---------------------------------------------------------------------------| +| [Arc42](architecture/) | Architecture documentation for the discovery finder. | +| [Guideline to use aws-cognito](guideline-aws-cognito-configuration.md) | Documentation to use aws cognito as identity provider | +| [Guideline to use edc-extension](guideline-edc-extension-configuration.md) | Documentation to build and use the edc extension for access control | +| [Development](development/) | Useful collections for development like postman/insomnia collections etc. | \ No newline at end of file diff --git a/docs/development/insomnia/aas-registry-v3-insomnia-collection.json b/docs/development/insomnia/aas-registry-v3-insomnia-collection.json new file mode 100644 index 00000000..f0a694b7 --- /dev/null +++ b/docs/development/insomnia/aas-registry-v3-insomnia-collection.json @@ -0,0 +1 @@ +{"_type":"export","__export_format":4,"__export_date":"2024-11-21T13:11:25.163Z","__export_source":"insomnia.desktop.app:v9.1.1","resources":[{"_id":"req_baa07f78900e45fe9871e99295da5c28","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732192658211,"created":1715771676688,"url":"{{baseUrl}}/api/v3/shell-descriptors","name":"Create Shell","description":"","method":"POST","body":{"mimeType":"application/json","text":"{\n \"idShort\": \"id-short\",\n \"id\": \"c931c4ea-c552-470f-80a2-a4ea9e5364dc\",\n \"description\": [\n {\n \"language\": \"en\",\n \"text\": \"This is an example\"\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturerPartId\",\n \"value\": \"manufacturerId-1\"\n }\n ],\n \"submodelDescriptors\": [\n {\n \"idShort\": \"bom-as-built\",\n \"id\": \"d8b50cad-041a-4ec8-bd4b-3d79be00456b\",\n \"endpoints\": [\n {\n \"interface\": \"bom as Built\",\n \"protocolInformation\": {\n \"href\": \"/submodel/123/$value\",\n \"endpointProtocol\": \"HTTP\",\n \"endpointProtocolVersion\": [\n \"1.1\"\n ],\n \"subprotocol\": \"\",\n \"subprotocolBody\":\"assetId=1;\",\n \"subprotocolBodyEncoding\": \"plain\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"submodel-descriptor für das Model bom_as_specified\"\n },\n {\n \"language\": \"en\",\n \"text\": \"submodel-descriptor forModel bom_as_specified\"\n }\n ]\n }\n ]\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"},{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_4f1d0e2e4c09488bb6edf1c7b803bae0"}],"authentication":{},"metaSortKey":-1715771674605,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_2889427b766d47fe9d4c47161cf4f4b0","parentId":"fld_bd5173385ef64178a86fbcaa103c479a","modified":1715771676681,"created":1715771676681,"name":"Asset Administration Shell Registry","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1715771674606,"_type":"request_group"},{"_id":"fld_bd5173385ef64178a86fbcaa103c479a","parentId":"wrk_scratchpad","modified":1732194628349,"created":1715771676658,"name":"aas-registry-v3","description":"","environment":{},"environmentPropertyOrder":{},"metaSortKey":-1715771834790,"_type":"request_group"},{"_id":"wrk_scratchpad","parentId":null,"modified":1715770262839,"created":1715770262839,"name":"Scratch Pad","description":"","scope":"collection","_type":"workspace"},{"_id":"req_0535ff6040df420eb0c5849bb2130c02","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732192915545,"created":1715771676689,"url":"{{baseUrl}}/api/v3/shell-descriptors","name":"Get All Shells","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[{"name":"limit","value":"100","disabled":true},{"name":"cursor","value":null,"disabled":true},{"name":"","value":null,"disabled":true}],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","description":"BPN (This is normally send via EDC)","id":"pair_5756c12f015149f391868e4003b86f87"}],"authentication":{},"metaSortKey":-1715771674604,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_55e7470dd976424db14c35ef8ffcb6f5","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193083254,"created":1715771676690,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier","name":"Get Shell by Id","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[{"id":"pair_a3dc04eef80c4cfbbff9a976389e399a","name":"","value":"","description":""}],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","description":"BPN (This is normally send via EDC)","id":"pair_7b074762a2614db9bb940dc6d4d70405"}],"authentication":{},"metaSortKey":-1715771674603,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_0e0962ee6bf0428e92563f8c9f74416e","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193112647,"created":1715771676691,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier","name":"Update Shell","description":"","method":"PUT","body":{"mimeType":"application/json","text":"{\n \"idShort\": \"id-short-1\",\n \"id\": \"c931c4ea-c552-470f-80a2-a4ea9e5364dc\",\n \"description\": [\n {\n \"language\": \"en\",\n \"text\": \"This is an example\"\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturerPartId\",\n \"value\": \"manufacturerId-1\"\n }\n ],\n \"submodelDescriptors\": [\n {\n \"idShort\": \"bom-as-built\",\n \"id\": \"d8b50cad-041a-4ec8-bd4b-3d79be00456b\",\n \"endpoints\": [\n {\n \"interface\": \"bom as Built\",\n \"protocolInformation\": {\n \"href\": \"/submodel/123/$value\",\n \"endpointProtocol\": \"HTTP\",\n \"endpointProtocolVersion\": [\n \"1.1\"\n ],\n \"subprotocol\": \"\",\n \"subprotocolBody\":\"assetId=1;\",\n \"subprotocolBodyEncoding\": \"plain\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"submodel-descriptor für das Model bom_as_specified\"\n },\n {\n \"language\": \"en\",\n \"text\": \"submodel-descriptor forModel bom_as_specified\"\n }\n ]\n }\n ]\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"},{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_0af5ec1e99d24e589f62e9acc19e7738"}],"authentication":{},"metaSortKey":-1715771674602,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_eb038d353142443b92a88f86c5764a54","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193229463,"created":1715771676691,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier","name":"Delete Shell","description":"","method":"DELETE","body":{},"preRequestScript":"","parameters":[],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_d6ec907bbc414002b95e7d266a6e259b"}],"authentication":{},"metaSortKey":-1715771674601,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_6e1b021758864afa84556570aa0bdb6b","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193294455,"created":1715771676692,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier/submodel-descriptors","name":"Create new Submodel","description":"","method":"POST","body":{"mimeType":"application/json","text":"{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"},{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_b59b76d2ddbc4aae981a9a37779f2b48"}],"authentication":{},"metaSortKey":-1715771674600,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_1f19b463d7a04de1b19b9e052b479fdb","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193383238,"created":1715771676693,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier/submodel-descriptors","name":"Get Submodel by Id","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[{"name":"limit","value":null,"disabled":true},{"name":"cursor","value":null,"disabled":true}],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","description":"BPN (This is normally send via EDC)","id":"pair_2272a77944b34907b2354717c6165317"}],"authentication":{},"metaSortKey":-1715771674599,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_4f500e2aad054c5aa67cac6edf41ddb9","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193389737,"created":1715771676693,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier/submodel-descriptors/:submodelIdentifier","name":"Get specific Submodel by Id","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_5b398998a43243baa60f9635886c7b0e"}],"authentication":{},"metaSortKey":-1715771674598,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"},{"name":"submodelIdentifier","value":"{% base64 'encode', 'normal', '341f63de-728a-4b6d-9c72-c0d9ba4f8c7d' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_6b6799a756ca44f3be9722a8dcc27053","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193442405,"created":1715771676694,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier/submodel-descriptors/:submodelIdentifier","name":"Update specific Submodel by Id","description":"","method":"PUT","body":{"mimeType":"application/json","text":"{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample-1\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"},{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_ef6585d1bab04850a0a87bfec2d29b7e"}],"authentication":{},"metaSortKey":-1715771674597,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"},{"name":"submodelIdentifier","value":"{% base64 'encode', 'normal', '341f63de-728a-4b6d-9c72-c0d9ba4f8c7d' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_fcf9c5d1e2b545b7b310278d274fa9f5","parentId":"fld_2889427b766d47fe9d4c47161cf4f4b0","modified":1732193486609,"created":1715771676694,"url":"{{baseUrl}}/api/v3/shell-descriptors/:aasIdentifier/submodel-descriptors/:submodelIdentifier","name":"Delete specific Submodel by Id","description":"","method":"DELETE","body":{},"preRequestScript":"","parameters":[],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_97acee19954b453e8f657c61e82151b1"}],"authentication":{},"metaSortKey":-1715771674596,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"},{"name":"submodelIdentifier","value":"{% base64 'encode', 'normal', '341f63de-728a-4b6d-9c72-c0d9ba4f8c7d' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_0482bcca3fda4b5fa3c80b83ba2f606b","parentId":"fld_b9c51ca79bbd4a008874ff61c079bbcb","modified":1732193584837,"created":1715771676695,"url":"{{baseUrl}}/api/v3/lookup/shells","name":"Get list of ShellIds (exact match)","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[{"name":"limit","value":null,"disabled":true,"id":"pair_8ff20bebe6044a938ec1d77310b49333"},{"name":"cursor","value":null,"disabled":true,"id":"pair_e155576ce04947c8a225d64c362afdb5"},{"name":"assetIds","value":"{% base64 'encode', 'normal', '{\"name\":\"manufacturerPartId\",\"value\":\"manufacturerId-1\"}' %}","disabled":false,"id":"pair_b633104cc01b4271aa1ed9f953a287ee"}],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","description":"BPN (This is normally send via EDC)","id":"pair_378390cdb7f148e5b568a26e1c78b5f6"}],"authentication":{},"metaSortKey":-1715771674594,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_b9c51ca79bbd4a008874ff61c079bbcb","parentId":"fld_bd5173385ef64178a86fbcaa103c479a","modified":1715771676695,"created":1715771676695,"name":"Registry and Discovery","description":"","environment":{},"environmentPropertyOrder":null,"metaSortKey":-1715771674595,"_type":"request_group"},{"_id":"req_fa8705acd8704b6fae87c93a039b99c9","parentId":"fld_b9c51ca79bbd4a008874ff61c079bbcb","modified":1732193602378,"created":1715771676696,"url":"{{baseUrl}}/api/v3/lookup/shells/:aasIdentifier","name":"Get SpecificAssetIds by aasIdentifier","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[],"headers":[{"name":"Edc-Bpn","value":"{{edcBpn}}","description":"BPN (This is normally send via EDC)","id":"pair_4dd7dfaa37074ebc92f5193062dc0ae2"}],"authentication":{},"metaSortKey":-1715771674593,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_53f98c2e4271437faa30c2c096d63a0c","parentId":"fld_b9c51ca79bbd4a008874ff61c079bbcb","modified":1732193642954,"created":1715771676697,"url":"{{baseUrl}}/api/v3/lookup/shells/:aasIdentifier","name":"Update SpecificAssetIds by aasIdentifier (overwrite existing List)","description":"","method":"POST","body":{"mimeType":"application/json","text":"[\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n }\n]"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"},{"name":"Edc-Bpn","value":"{{edcBpn}}","description":"BPN (This is normally send via EDC)","id":"pair_c1a32ca19c094e72b825aed3282a2692"}],"authentication":{},"metaSortKey":-1715771674592,"isPrivate":false,"pathParameters":[{"name":"aasIdentifier","value":"{% base64 'encode', 'normal', 'c931c4ea-c552-470f-80a2-a4ea9e5364dc' %}"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_c1adbff262e343699c23ce99f2c49c99","parentId":"fld_b9c51ca79bbd4a008874ff61c079bbcb","modified":1732193907948,"created":1715771676697,"url":"{{baseUrl}}/api/v3/lookup/shellsByAssetLink","name":"Get list of ShellIds without encoding","description":"","method":"POST","body":{"mimeType":"application/json","text":"[\n {\n \"name\": \"manufacturerPartId\",\n \"value\": \"manufacturerId-1\"\n }\n]"},"preRequestScript":"","parameters":[{"name":"limit","value":null,"disabled":true},{"name":"cursor","value":null,"disabled":true}],"headers":[{"name":"Content-Type","value":"application/json"},{"name":"Edc-Bpn","value":"{{edcBpn}}","id":"pair_8e57ec17c2f341b382d75960267709c8"}],"authentication":{},"metaSortKey":-1715771674591,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"env_99d30891da4bdcebc63947a8fc17f076de878684","parentId":"wrk_scratchpad","modified":1732193021984,"created":1715770284186,"name":"Base Environment","data":{"baseUrl":"http://localhost:4243","edcBpn":"TENANT_ONE"},"dataPropertyOrder":{"&":["baseUrl","edcBpn"]},"color":null,"isPrivate":false,"metaSortKey":1715770284186,"_type":"environment"},{"_id":"jar_99d30891da4bdcebc63947a8fc17f076de878684","parentId":"wrk_scratchpad","modified":1715770284199,"created":1715770284199,"name":"Default Jar","cookies":[],"_type":"cookie_jar"}]} \ No newline at end of file diff --git a/docs/development/insomnia/access-rule-management-v3-insomnia-collection.json b/docs/development/insomnia/access-rule-management-v3-insomnia-collection.json new file mode 100644 index 00000000..0bc69a2e --- /dev/null +++ b/docs/development/insomnia/access-rule-management-v3-insomnia-collection.json @@ -0,0 +1 @@ +{"_type":"export","__export_format":4,"__export_date":"2024-11-21T13:11:55.617Z","__export_source":"insomnia.desktop.app:v9.1.1","resources":[{"_id":"req_08ac4502374842e5938be39e1c738150","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1715770471062,"created":1715770471062,"url":"{{baseUrl}}/api/v3/access-controls/rules","name":"get Rules","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[],"headers":[],"authentication":{},"metaSortKey":-1715770469258,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"fld_efa89625628f4f08ad16e370ea30cf04","parentId":"wrk_scratchpad","modified":1732194646936,"created":1715770471060,"name":"access-rule-management-v3","description":"","environment":{},"environmentPropertyOrder":{},"metaSortKey":-1715771834765,"_type":"request_group"},{"_id":"wrk_scratchpad","parentId":null,"modified":1715770262839,"created":1715770262839,"name":"Scratch Pad","description":"","scope":"collection","_type":"workspace"},{"_id":"req_7d9139c15b734d8395bfc6600dcb8f84","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1715948665444,"created":1715770471063,"url":"{{baseUrl}}/api/v3/access-controls/rules","name":"create Rule","description":"","method":"POST","body":{"mimeType":"application/json","text":"{\n \"validFrom\": \"2020-01-02T03:04:05Z\",\n \"validTo\": \"4999-01-02T03:04:05Z\",\n \"description\": \"ACME policy within set validity period\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPN_PROVIDER_1C\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"oem\",\n \"operator\": \"eq\",\n \"value\": \"oem-000-001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"oem\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified\"\n }\n ]\n }\n ]\n }\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"}],"authentication":{},"metaSortKey":-1715770469257,"isPrivate":false,"pathParameters":[],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_fb5af50268a64ca49fc7d919efa6fe65","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1732193975148,"created":1715770471064,"url":"{{baseUrl}}/api/v3/access-controls/rules/:ruleId","name":"get Rule by ruleId","description":"","method":"GET","body":{},"preRequestScript":"","parameters":[],"headers":[],"authentication":{},"metaSortKey":-1715770469256,"isPrivate":false,"pathParameters":[{"name":"ruleId","value":"1"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_cf662dd0be944fddb27857aed54dc13b","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1732194014529,"created":1715770471064,"url":"{{baseUrl}}/api/v3/access-controls/rules/:ruleId","name":"update Rule by ruleId","description":"","method":"PUT","body":{"mimeType":"application/json","text":"{\n \"id\": 1,\n \"tid\": \"TENANT_ONE\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPNL00000000000A\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"manufacturerPartId\",\n \"operator\": \"eq\",\n \"value\": \"99991\"\n },\n {\n \"attribute\": \"customerPartId\",\n \"operator\": \"eq\",\n \"value\": \"ACME001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"manufacturerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"customerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"partInstanceId\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"Traceabilityv1.1.0\"\n },\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"ProductCarbonFootprintv1.1.0\"\n }\n ]\n }\n ]\n },\n \"description\": \"Access rule description.\",\n \"validFrom\": \"2024-01-02T03:04:05Z\",\n \"validTo\": \"2024-06-07T08:09:10Z\"\n}"},"preRequestScript":"","parameters":[],"headers":[{"name":"Content-Type","value":"application/json"}],"authentication":{},"metaSortKey":-1715770469255,"isPrivate":false,"pathParameters":[{"name":"ruleId","value":"1"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"req_b025742919054097b87fe1fe795cb26e","parentId":"fld_efa89625628f4f08ad16e370ea30cf04","modified":1732194032123,"created":1715770471065,"url":"{{baseUrl}}/api/v3/access-controls/rules/:ruleId","name":"delete rule by ruleId","description":"","method":"DELETE","body":{},"preRequestScript":"","parameters":[],"headers":[],"authentication":{},"metaSortKey":-1715770469254,"isPrivate":false,"pathParameters":[{"name":"ruleId","value":"1"}],"settingStoreCookies":true,"settingSendCookies":true,"settingDisableRenderRequestBody":false,"settingEncodeUrl":true,"settingRebuildPath":true,"settingFollowRedirects":"global","_type":"request"},{"_id":"env_99d30891da4bdcebc63947a8fc17f076de878684","parentId":"wrk_scratchpad","modified":1732193021984,"created":1715770284186,"name":"Base Environment","data":{"baseUrl":"http://localhost:4243","edcBpn":"TENANT_ONE"},"dataPropertyOrder":{"&":["baseUrl","edcBpn"]},"color":null,"isPrivate":false,"metaSortKey":1715770284186,"_type":"environment"},{"_id":"jar_99d30891da4bdcebc63947a8fc17f076de878684","parentId":"wrk_scratchpad","modified":1715770284199,"created":1715770284199,"name":"Default Jar","cookies":[],"_type":"cookie_jar"}]} \ No newline at end of file diff --git a/docs/development/postman/README.md b/docs/development/postman/README.md deleted file mode 100644 index 4ba50584..00000000 --- a/docs/development/postman/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# DTR Postman Collection - -## Postman -### DTR Postman Collection: -The postman collection can be used to call all provided APIs of the DTR. - -### Access rule management Postman Collection: -The postman collection can be used to call all provided APIs of the access rule management. - -### Setup Postman - -To install postman, download the newest version: - - -### Import Postman collection - -Follow the steps here to import the collection: - - -### NOTICE - -This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - -- SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2023 Robert Bosch Manufacturing Solutions GmbH -- SPDX-FileCopyrightText: 2023 Contributors to the Eclipse Foundation -- Source URL: https://github.com/eclipse-tractusx/sldt-digital-twin-registry.git diff --git a/docs/development/postman/tractusx-dtr-aas-3.1.0-collection.json b/docs/development/postman/aas-registry-v3-postman-collection.json similarity index 61% rename from docs/development/postman/tractusx-dtr-aas-3.1.0-collection.json rename to docs/development/postman/aas-registry-v3-postman-collection.json index 026688b3..aa15cdb1 100644 --- a/docs/development/postman/tractusx-dtr-aas-3.1.0-collection.json +++ b/docs/development/postman/aas-registry-v3-postman-collection.json @@ -1,7 +1,7 @@ { "info": { - "_postman_id": "93ec8210-a45b-4bae-9964-8bad1aaaa32e", - "name": "tractusx-dtr-aas-3.1.0", + "_postman_id": "6611c4d1-8e1a-4749-b848-fbc749e5567a", + "name": "aas-registry-v3", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ @@ -18,13 +18,13 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "default" } ], "body": { "mode": "raw", - "raw": "{\n \"idShort\": \"idShortExample\",\n \"id\": \"e1eba3d7-91f0-4dac-a730-eaa1d35e035c-2\", \n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"example text\"\n }\n ],\n \"displayName\": [\n {\n \"language\": \"de\",\n \"text\": \"this is an example description1\"\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturePartId\",\n \"value\": \"1234\"\n },\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n },\n {\n \"name\": \"serialnr\",\n \"value\": \"12345\",\n \"externalSubjectId\":{\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Property\",\n \"value\": \"CONSUMER_BPN\"\n }\n ]\n }\n }\n ],\n \"submodelDescriptors\": [\n {\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"5hg\",\n \"subprotocolBody\":\"\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"sec\",\n \"value\": \"1\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"cd47615b-daf3-4036-8670-d2f89349d388-2\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n }\n ]\n}", + "raw": "{\n \"idShort\": \"id-short\",\n \"id\": \"c931c4ea-c552-470f-80a2-a4ea9e5364dc\",\n \"description\": [\n {\n \"language\": \"en\",\n \"text\": \"This is an example\"\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturerPartId\",\n \"value\": \"manufacturerId-1\"\n }\n ],\n \"submodelDescriptors\": [\n {\n \"idShort\": \"bom-as-built\",\n \"id\": \"d8b50cad-041a-4ec8-bd4b-3d79be00456b\",\n \"endpoints\": [\n {\n \"interface\": \"bom as Built\",\n \"protocolInformation\": {\n \"href\": \"/submodel/123/$value\",\n \"endpointProtocol\": \"HTTP\",\n \"endpointProtocolVersion\": [\n \"1.1\"\n ],\n \"subprotocol\": \"\",\n \"subprotocolBody\":\"assetId=1;\",\n \"subprotocolBodyEncoding\": \"plain\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"submodel-descriptor für das Model bom_as_specified\"\n },\n {\n \"language\": \"en\",\n \"text\": \"submodel-descriptor forModel bom_as_specified\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" @@ -45,7 +45,7 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "description": "BPN (This is normally send via EDC)", "type": "default" } @@ -91,7 +91,7 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "description": "BPN (This is normally send via EDC)", "type": "default" } @@ -110,7 +110,7 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -128,13 +128,13 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "default" } ], "body": { "mode": "raw", - "raw": "{\n \"idShort\": \"idShortExample\",\n \"id\": \"e1eba3d7-91f0-4dac-a730-eaa1d35e035c-2\",\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"example text\"\n }\n ],\n \"displayName\": [\n {\n \"language\": \"de\",\n \"text\": \"this is an example description1\"\n }\n ],\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturePartId\",\n \"value\": \"12345\",\n \"externalSubjectId\":{\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Property\",\n \"value\": \"CONSUMER_BPN\"\n }\n ]\n }\n },\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n },\n {\n \"name\": \"serialnr\",\n \"value\": \"1234\",\n \"externalSubjectId\":{\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Property\",\n \"value\": \"CONSUMER_BPN\"\n }\n ]\n }\n }\n ],\n \"submodelDescriptors\": [\n {\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"5hg\",\n \"subprotocolBody\":\"\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"cd47615b-daf3-4036-8670-d2f89349d388-2\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n }\n ]\n}", + "raw": "{\n \"idShort\": \"id-short-1\",\n \"id\": \"c931c4ea-c552-470f-80a2-a4ea9e5364dc\",\n \"description\": [\n {\n \"language\": \"en\",\n \"text\": \"This is an example\"\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturerPartId\",\n \"value\": \"manufacturerId-1\"\n }\n ],\n \"submodelDescriptors\": [\n {\n \"idShort\": \"bom-as-built\",\n \"id\": \"d8b50cad-041a-4ec8-bd4b-3d79be00456b\",\n \"endpoints\": [\n {\n \"interface\": \"bom as Built\",\n \"protocolInformation\": {\n \"href\": \"/submodel/123/$value\",\n \"endpointProtocol\": \"HTTP\",\n \"endpointProtocolVersion\": [\n \"1.1\"\n ],\n \"subprotocol\": \"\",\n \"subprotocolBody\":\"assetId=1;\",\n \"subprotocolBodyEncoding\": \"plain\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"submodel-descriptor für das Model bom_as_specified\"\n },\n {\n \"language\": \"en\",\n \"text\": \"submodel-descriptor forModel bom_as_specified\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" @@ -155,7 +155,7 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -173,7 +173,7 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "default" } ], @@ -191,7 +191,7 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -209,13 +209,13 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "default" } ], "body": { "mode": "raw", - "raw": "{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}", + "raw": "{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}", "options": { "raw": { "language": "json" @@ -237,7 +237,7 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -255,7 +255,7 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "description": "BPN (This is normally send via EDC)", "type": "default" } @@ -287,7 +287,7 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -305,7 +305,7 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "default" } ], @@ -325,12 +325,12 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" }, { "key": "submodelIdentifier", - "value": "Y2Q0NzYxNWItZGFmMy00MDM2LTg2NzAtZDJmODkzNDlkMzg4LTI=", + "value": "MzQxZjYzZGUtNzI4YS00YjZkLTljNzItYzBkOWJhNGY4Yzdk", "description": "submodelIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -348,13 +348,13 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "default" } ], "body": { "mode": "raw", - "raw": "{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}", + "raw": "{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"NONE\",\n \"value\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}", "options": { "raw": { "language": "json" @@ -377,12 +377,12 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" }, { "key": "submodelIdentifier", - "value": "Y2Q0NzYxNWItZGFmMy00MDM2LTg2NzAtZDJmODkzNDlkMzg4LTI=", + "value": "MzQxZjYzZGUtNzI4YS00YjZkLTljNzItYzBkOWJhNGY4Yzdk", "description": "submodelIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -400,7 +400,7 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "default" } ], @@ -420,12 +420,12 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" }, { "key": "submodelIdentifier", - "value": "Y2Q0NzYxNWItZGFmMy00MDM2LTg2NzAtZDJmODkzNDlkMzg4LTI=", + "value": "MzQxZjYzZGUtNzI4YS00YjZkLTljNzItYzBkOWJhNGY4Yzdk", "description": "submodelIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -445,13 +445,13 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "description": "BPN (This is normally send via EDC)", "type": "default" } ], "url": { - "raw": "{{baseUrl}}/api/v3/lookup/shells?assetIds=[{\"name\":\"oen\",\"value\":\"1239485\"},{\"name\":\"manufacturePartId\",\"value\":\"1234\"}]", + "raw": "{{baseUrl}}/api/v3/lookup/shells?assetIds=eyJuYW1lIjoibWFudWZhY3R1cmVyUGFydElkIiwidmFsdWUiOiJtYW51ZmFjdHVyZXJJZC0xIn0=", "host": [ "{{baseUrl}}" ], @@ -474,7 +474,8 @@ }, { "key": "assetIds", - "value": "[{\"name\":\"oen\",\"value\":\"1239485\"},{\"name\":\"manufacturePartId\",\"value\":\"1234\"}]" + "value": "eyJuYW1lIjoibWFudWZhY3R1cmVyUGFydElkIiwidmFsdWUiOiJtYW51ZmFjdHVyZXJJZC0xIn0=", + "description": "{\"name\":\"manufacturerPartId\",\"value\":\"manufacturerId-1\"}" } ] } @@ -488,7 +489,7 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "description": "BPN (This is normally send via EDC)", "type": "default" } @@ -508,7 +509,7 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -523,14 +524,14 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "description": "BPN (This is normally send via EDC)", "type": "default" } ], "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n }\n ]", + "raw": "[\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n }\n]", "options": { "raw": { "language": "json" @@ -552,7 +553,7 @@ "variable": [ { "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", + "value": "YzkzMWM0ZWEtYzU1Mi00NzBmLTgwYTItYTRlYTllNTM2NGRj", "description": "aasIdentifier as UTF8-BASE64-URL-encoded" } ] @@ -567,13 +568,13 @@ "header": [ { "key": "Edc-Bpn", - "value": "{{EDC-BPN}}", + "value": "{{edcBpn}}", "type": "text" } ], "body": { "mode": "raw", - "raw": "[\n {\n \"name\": \"manufacturePartId\",\n \"value\": \"1234\"\n },\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n },\n {\n \"name\": \"serialnr\",\n \"value\": \"12345\"\n }\n] ", + "raw": "[\n {\n \"name\": \"manufacturerPartId\",\n \"value\": \"manufacturerId-1\"\n }\n]", "options": { "raw": { "language": "json" @@ -633,7 +634,12 @@ "variable": [ { "key": "baseUrl", - "value": "", + "value": "http://localhost:4243", + "type": "default" + }, + { + "key": "edcBpn", + "value": "TENANT_ONE", "type": "default" } ] diff --git a/docs/development/postman/access-rule-management-v3-postman-collection.json b/docs/development/postman/access-rule-management-v3-postman-collection.json new file mode 100644 index 00000000..9b7b6834 --- /dev/null +++ b/docs/development/postman/access-rule-management-v3-postman-collection.json @@ -0,0 +1,168 @@ +{ + "info": { + "_postman_id": "bcb4b2b1-3eff-4c0e-a6ac-bb74cb4f7089", + "name": "access-rule-management-v3", + "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" + }, + "item": [ + { + "name": "get Rules", + "request": { + "method": "GET", + "header": [], + "url": "{{baseUrl}}/api/v3/access-controls/rules" + }, + "response": [] + }, + { + "name": "create Rule", + "request": { + "method": "POST", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"validFrom\": \"2020-01-02T03:04:05Z\",\n \"validTo\": \"4999-01-02T03:04:05Z\",\n \"description\": \"ACME policy within set validity period\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPN_PROVIDER_1C\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"oem\",\n \"operator\": \"eq\",\n \"value\": \"oem-000-001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"oem\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"urn:bamm:io.catenax.bom_as_specified:2.0.0#SingleLevelBomAsSpecified\"\n }\n ]\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": "{{baseUrl}}/api/v3/access-controls/rules" + }, + "response": [] + }, + { + "name": "get Rule by ruleId", + "request": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v3/access-controls/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v3", + "access-controls", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "ruleId", + "value": "1" + } + ] + } + }, + "response": [] + }, + { + "name": "update Rule by ruleId", + "request": { + "method": "PUT", + "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"id\": 1,\n \"tid\": \"TENANT_ONE\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPNL00000000000A\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"manufacturerPartId\",\n \"operator\": \"eq\",\n \"value\": \"99991\"\n },\n {\n \"attribute\": \"customerPartId\",\n \"operator\": \"eq\",\n \"value\": \"ACME001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"manufacturerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"customerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"partInstanceId\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"Traceabilityv1.1.0\"\n },\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"ProductCarbonFootprintv1.1.0\"\n }\n ]\n }\n ]\n },\n \"description\": \"Access rule description.\",\n \"validFrom\": \"2024-01-02T03:04:05Z\",\n \"validTo\": \"2024-06-07T08:09:10Z\"\n}", + "options": { + "raw": { + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v3/access-controls/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v3", + "access-controls", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "ruleId", + "value": "1" + } + ] + } + }, + "response": [] + }, + { + "name": "delete rule by ruleId", + "request": { + "method": "DELETE", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v3/access-controls/rules/:ruleId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v3", + "access-controls", + "rules", + ":ruleId" + ], + "variable": [ + { + "key": "ruleId", + "value": "1" + } + ] + } + }, + "response": [] + } + ], + "auth": { + "type": "oauth2", + "oauth2": { + "clientSecret": "", + "clientId": "", + "accessTokenUrl": "", + "challengeAlgorithm": "S256", + "scope": "openid", + "redirect_uri": "", + "grant_type": "client_credentials", + "authUrl": "", + "addTokenTo": "header", + "client_authentication": "header" + } + }, + "event": [ + { + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "localhost:4243", + "type": "default" + } + ] +} \ No newline at end of file diff --git a/docs/development/postman/tractusx-dtr-aas-3.0.0-collection.json b/docs/development/postman/tractusx-dtr-aas-3.0.0-collection.json deleted file mode 100644 index 084ea29a..00000000 --- a/docs/development/postman/tractusx-dtr-aas-3.0.0-collection.json +++ /dev/null @@ -1,551 +0,0 @@ -{ - "info": { - "_postman_id": "0b8d254c-d218-498b-a815-aabc2612e345", - "name": "tractusx-dtr-aas-3.0.0", - "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" - }, - "item": [ - { - "name": "Asset Administration Shell Registry", - "item": [ - { - "name": "Create Shell", - "request": { - "auth": { - "type": "noauth" - }, - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"idShort\": \"idShortExample\",\n \"id\": \"e1eba3d7-91f0-4dac-a730-eaa1d35e035c-2\", \n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"example text\"\n }\n ],\n \"displayName\": [\n {\n \"language\": \"de\",\n \"text\": \"this is an example description1\"\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturePartId\",\n \"value\": \"1234\"\n },\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n },\n {\n \"name\": \"serialnr\",\n \"value\": \"12345\",\n \"externalSubjectId\":{\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Property\",\n \"value\": \"CONSUMER_BPN\"\n }\n ]\n }\n }\n ],\n \"submodelDescriptors\": [\n {\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"5hg\",\n \"subprotocolBody\":\"\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\",\n \"key\": \"sec\",\n \"value\": \"1\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"cd47615b-daf3-4036-8670-d2f89349d388-2\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": "{{baseUrl}}/api/v3.0/shell-descriptors" - }, - "response": [] - }, - { - "name": "Get All Shells", - "request": { - "auth": { - "type": "noauth" - }, - "method": "GET", - "header": [ - { - "key": "Edc-Bpn", - "value": "CONSUMER_BPN", - "description": "BPN (This is normally send via EDC)", - "type": "default" - } - ], - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors" - ], - "query": [ - { - "key": "limit", - "value": "100", - "disabled": true - }, - { - "key": "cursor", - "value": null, - "disabled": true - }, - { - "key": "", - "value": null, - "disabled": true - } - ] - } - }, - "response": [] - }, - { - "name": "Get Shell by Id", - "request": { - "auth": { - "type": "noauth" - }, - "method": "GET", - "header": [ - { - "key": "Edc-Bpn", - "value": "", - "description": "BPN (This is normally send via EDC)", - "type": "default" - } - ], - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Update Shell", - "request": { - "auth": { - "type": "noauth" - }, - "method": "PUT", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"idShort\": \"idShortExample\",\n \"id\": \"e1eba3d7-91f0-4dac-a730-eaa1d35e035c-2\",\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"example text\"\n }\n ],\n \"displayName\": [\n {\n \"language\": \"de\",\n \"text\": \"this is an example description1\"\n }\n ],\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"specificAssetIds\": [\n {\n \"name\": \"manufacturePartId\",\n \"value\": \"12345\",\n \"externalSubjectId\":{\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Property\",\n \"value\": \"CONSUMER_BPN\"\n }\n ]\n }\n },\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n },\n {\n \"name\": \"serialnr\",\n \"value\": \"1234\",\n \"externalSubjectId\":{\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Property\",\n \"value\": \"CONSUMER_BPN\"\n }\n ]\n }\n }\n ],\n \"submodelDescriptors\": [\n {\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"5hg\",\n \"subprotocolBody\":\"\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"cd47615b-daf3-4036-8670-d2f89349d388-2\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"urn:bamm:io.catenax.serial_part_typization:1.1.0#SerialPartTypization\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete Shell", - "request": { - "auth": { - "type": "noauth" - }, - "method": "DELETE", - "header": [], - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Create new Submodel", - "request": { - "auth": { - "type": "noauth" - }, - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier/submodel-descriptors", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier", - "submodel-descriptors" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Get Submodel by Id", - "request": { - "auth": { - "type": "noauth" - }, - "method": "GET", - "header": [ - { - "key": "Edc-Bpn", - "value": "", - "description": "BPN (This is normally send via EDC)", - "type": "default" - } - ], - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier/submodel-descriptors", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier", - "submodel-descriptors" - ], - "query": [ - { - "key": "limit", - "value": null, - "disabled": true - }, - { - "key": "cursor", - "value": null, - "disabled": true - } - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Get specific Submodel by Id", - "request": { - "auth": { - "type": "noauth" - }, - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier/submodel-descriptors/:submodelIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier", - "submodel-descriptors", - ":submodelIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - }, - { - "key": "submodelIdentifier", - "value": "Y2Q0NzYxNWItZGFmMy00MDM2LTg2NzAtZDJmODkzNDlkMzg4LTI=", - "description": "submodelIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Update specific Submodel by Id", - "request": { - "auth": { - "type": "noauth" - }, - "method": "PUT", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"endpoints\": [\n {\n \"interface\": \"interfaceNameExample\",\n \"protocolInformation\": {\n \"href\": \"endpointAddressExample\",\n \"endpointProtocol\": \"endpointProtocolExample\",\n \"endpointProtocolVersion\": [\n \"e\"\n ],\n \"subprotocol\": \"subprotocolExample\",\n \"subprotocolBody\": \"subprotocolBodyExample\",\n \"subprotocolBodyEncoding\": \"subprotocolBodyExample\",\n \"securityAttributes\": [\n {\n \"type\": \"NONE\"\n }\n ]\n }\n }\n ],\n \"idShort\": \"idShortExample\",\n \"id\": \"341f63de-728a-4b6d-9c72-c0d9ba4f8c7d\",\n \"semanticId\": {\n \"type\": \"ExternalReference\",\n \"keys\": [\n {\n \"type\": \"Submodel\",\n \"value\": \"semanticIdExample\"\n }\n ]\n },\n \"description\": [\n {\n \"language\": \"de\",\n \"text\": \"hello text\"\n },\n {\n \"language\": \"en\",\n \"text\": \"hello s\"\n }\n ]\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier/submodel-descriptors/:submodelIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier", - "submodel-descriptors", - ":submodelIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - }, - { - "key": "submodelIdentifier", - "value": "Y2Q0NzYxNWItZGFmMy00MDM2LTg2NzAtZDJmODkzNDlkMzg4LTI=", - "description": "submodelIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Delete specific Submodel by Id", - "request": { - "auth": { - "type": "noauth" - }, - "method": "DELETE", - "header": [], - "url": { - "raw": "{{baseUrl}}/api/v3.0/shell-descriptors/:aasIdentifier/submodel-descriptors/:submodelIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "shell-descriptors", - ":aasIdentifier", - "submodel-descriptors", - ":submodelIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - }, - { - "key": "submodelIdentifier", - "value": "Y2Q0NzYxNWItZGFmMy00MDM2LTg2NzAtZDJmODkzNDlkMzg4LTI=", - "description": "submodelIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - } - ] - }, - { - "name": "Registry and Discovery", - "item": [ - { - "name": "Get list of ShellIds (exact match)", - "request": { - "method": "GET", - "header": [ - { - "key": "Edc-Bpn", - "value": "", - "description": "BPN (This is normally send via EDC)", - "type": "default" - } - ], - "url": { - "raw": "{{baseUrl}}/api/v3.0/lookup/shells?assetIds=[{\"name\":\"oen\",\"value\":\"1239485\"},{\"name\":\"manufacturePartId\",\"value\":\"1234\"}]", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "lookup", - "shells" - ], - "query": [ - { - "key": "limit", - "value": null, - "disabled": true - }, - { - "key": "cursor", - "value": null, - "disabled": true - }, - { - "key": "assetIds", - "value": "[{\"name\":\"oen\",\"value\":\"1239485\"},{\"name\":\"manufacturePartId\",\"value\":\"1234\"}]" - } - ] - } - }, - "response": [] - }, - { - "name": "Get SpecificAssetIds by aasIdentifier", - "request": { - "method": "GET", - "header": [ - { - "key": "Edc-Bpn", - "value": "", - "description": "BPN (This is normally send via EDC)", - "type": "default" - } - ], - "url": { - "raw": "{{baseUrl}}/api/v3.0/lookup/shells/:aasIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "lookup", - "shells", - ":aasIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - }, - { - "name": "Update SpecificAssetIds by aasIdentifier (overwrite existing List)", - "request": { - "method": "POST", - "header": [ - { - "key": "Edc-Bpn", - "value": "", - "description": "BPN (This is normally send via EDC)", - "type": "default" - } - ], - "body": { - "mode": "raw", - "raw": "[\n {\n \"name\": \"oen\",\n \"value\": \"1239485\"\n }\n ]", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/v3.0/lookup/shells/:aasIdentifier", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3.0", - "lookup", - "shells", - ":aasIdentifier" - ], - "variable": [ - { - "key": "aasIdentifier", - "value": "ZTFlYmEzZDctOTFmMC00ZGFjLWE3MzAtZWFhMWQzNWUwMzVjLTI", - "description": "aasIdentifier as UTF8-BASE64-URL-encoded" - } - ] - } - }, - "response": [] - } - ] - } - ], - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "baseUrl", - "value": "", - "type": "default" - } - ] -} \ No newline at end of file diff --git a/docs/development/postman/tractusx-dtr-access-rule-management-api-v1.0-collection.json b/docs/development/postman/tractusx-dtr-access-rule-management-api-v1.0-collection.json deleted file mode 100644 index 958f427a..00000000 --- a/docs/development/postman/tractusx-dtr-access-rule-management-api-v1.0-collection.json +++ /dev/null @@ -1,168 +0,0 @@ -{ - "info": { - "_postman_id": "47f1eefc-bd84-4c6b-9c30-2ff696b1dde0", - "name": "tractusx-dtr-access-rule-management-api-v1.0", - "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" - }, - "item": [ - { - "name": "get Rules", - "request": { - "method": "GET", - "header": [], - "url": "{{baseUrl}}/api/v3/access-controls/rules" - }, - "response": [] - }, - { - "name": "create Rule", - "request": { - "method": "POST", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"validFrom\": \"2020-01-02T03:04:05Z\",\n \"validTo\": \"4999-01-02T03:04:05Z\",\n \"description\": \"ACME policy within set validity period\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPNL00000000000A\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"manufacturerPartId\",\n \"operator\": \"eq\",\n \"value\": \"99991\"\n },\n {\n \"attribute\": \"customerPartId\",\n \"operator\": \"eq\",\n \"value\": \"ACME001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"manufacturerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"customerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"partInstanceId\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"urn:samm:net.catenax.vehicle.submodel_external1:1.0.0#Pcf\"\n }\n ]\n }\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": "{{baseUrl}}/api/v3/access-controls/rules" - }, - "response": [] - }, - { - "name": "get Rule by ruleId", - "request": { - "method": "GET", - "header": [], - "url": { - "raw": "{{baseUrl}}/api/v3/access-controls/rules/:ruleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3", - "access-controls", - "rules", - ":ruleId" - ], - "variable": [ - { - "key": "ruleId", - "value": "" - } - ] - } - }, - "response": [] - }, - { - "name": "update Rule by ruleId", - "request": { - "method": "PUT", - "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"id\": 1,\n \"tid\": \"00000000-1111-2222-3333-444444444444\",\n \"policyType\": \"AAS\",\n \"policy\": {\n \"accessRules\": [\n {\n \"attribute\": \"bpn\",\n \"operator\": \"eq\",\n \"value\": \"BPNL00000000000A\"\n },\n {\n \"attribute\": \"mandatorySpecificAssetIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"manufacturerPartId\",\n \"operator\": \"eq\",\n \"value\": \"99991\"\n },\n {\n \"attribute\": \"customerPartId\",\n \"operator\": \"eq\",\n \"value\": \"ACME001\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSpecificAssetIdNames\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"manufacturerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"customerPartId\"\n },\n {\n \"attribute\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"partInstanceId\"\n }\n ]\n },\n {\n \"attribute\": \"visibleSemanticIds\",\n \"operator\": \"includes\",\n \"values\": [\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"Traceabilityv1.1.0\"\n },\n {\n \"attribute\": \"modelUrn\",\n \"operator\": \"eq\",\n \"value\": \"ProductCarbonFootprintv1.1.0\"\n }\n ]\n }\n ]\n },\n \"description\": \"Access rule description.\",\n \"validFrom\": \"2024-01-02T03:04:05Z\",\n \"validTo\": \"2024-06-07T08:09:10Z\"\n}", - "options": { - "raw": { - "language": "json" - } - } - }, - "url": { - "raw": "{{baseUrl}}/api/v3/access-controls/rules/:ruleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3", - "access-controls", - "rules", - ":ruleId" - ], - "variable": [ - { - "key": "ruleId", - "value": "" - } - ] - } - }, - "response": [] - }, - { - "name": "delete rule by ruleId", - "request": { - "method": "DELETE", - "header": [], - "url": { - "raw": "{{baseUrl}}/api/v3/access-controls/rules/:ruleId", - "host": [ - "{{baseUrl}}" - ], - "path": [ - "api", - "v3", - "access-controls", - "rules", - ":ruleId" - ], - "variable": [ - { - "key": "ruleId", - "value": "" - } - ] - } - }, - "response": [] - } - ], - "auth": { - "type": "oauth2", - "oauth2": { - "clientSecret": "", - "clientId": "", - "accessTokenUrl": "", - "challengeAlgorithm": "S256", - "scope": "openid", - "redirect_uri": "", - "grant_type": "client_credentials", - "authUrl": "", - "addTokenTo": "header", - "client_authentication": "header" - } - }, - "event": [ - { - "listen": "prerequest", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - }, - { - "listen": "test", - "script": { - "type": "text/javascript", - "exec": [ - "" - ] - } - } - ], - "variable": [ - { - "key": "baseUrl", - "value": "", - "type": "default" - } - ] -} \ No newline at end of file