{ "info": { "_postman_id": "481808a1-8f9d-47b3-8e03-9302d22731d9", "name": " CDS Blueprint Processor API Reference", "description": "Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Blueprint Model Catalog", "item": [ { "name": "List all Blueprint Models", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model" ] }, "description": "Lists all blueprint models which are saved in CDS." }, "response": [] }, { "name": "Save a Blueprint Model", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/home/jakob/Downloads/cba.zip" } ] }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model" ] }, "description": "Saves a blueprint model by the given file input. There is no validation of the attached CBA happening when this API is called." }, "response": [] }, { "name": "Bootstrap CDS", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : true,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : true\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] }, "description": "Loads all Model Types, Resource Dictionaries and blueprint models which are included in CDS by default.Before starting to work with CDS, bootstrap should be called to load all the basic models that each orginization might support.Parameter values can be set as false to skip loading e.g. the Resource Dictionaries but this is not recommended." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Get a Blueprint Model by Name and Version", "protocolProfileBehavior": { "disabledSystemHeaders": {}, "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : true,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : true\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/by-name/pnf_netconf/version/1.0.0", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "by-name", "pnf_netconf", "version", "1.0.0" ] }, "description": "Get Meta-Data of a Blueprint Model by its name and version." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Download a Blueprint Model", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/download/by-name/pnf_netconf/version/1.0.0", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "download", "by-name", "pnf_netconf", "version", "1.0.0" ] }, "description": "Gets the CBA of a blueprint model by its name and version. Response can be saved to a file to download the CBA." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Download a Blueprint Model by ID", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/download/44471683-4446-4ed9-8b27-fac6a8f81e5e", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "download", "44471683-4446-4ed9-8b27-fac6a8f81e5e" ] }, "description": "Gets the CBA of a blueprint model by its ID. Response can be saved to a file to download the CBA." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Enrich a Blueprint Model", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/home/jakob/Downloads/PNF_DEMO.zip" } ], "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/enrich", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "enrich" ] }, "description": "Enriches the attached CBA and returns the enriched CBA zip file in the response.The enrichment process will complete the package by providing all the definition of types used." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Enrich and publish a Blueprint Model", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/home/jakob/Downloads/PNF_DEMO.zip" } ], "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/enrichandpublish", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "enrichandpublish" ] }, "description": "Enriches the attached CBA, validates it and saves it in CDS if validation was successful." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Search for Blueprints by a Keyword", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/meta-data/pnf_netconf", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "meta-data", "pnf_netconf" ] }, "description": "Lists all blueprint models by a matching keyword in any of the meta-data of the blueprint models.Blueprint models are just returned if a whole keyword is matching, not just parts of it. Not case-sensitive.Used by CDS UI." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Delete a Blueprint Model by Name", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/name/pnf_netconf/version/1.0.0", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "name", "pnf_netconf", "version", "1.0.0" ] }, "description": "Delete a blueprint model identified by its name and version from CDS." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Get Blueprints ordered", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/paged?limit=5&sort=DATE", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "paged" ], "query": [ { "key": "limit", "value": "5" }, { "key": "sort", "value": "DATE" } ] }, "description": "Lists all blueprint models which are saved in CDS in an ordered mode." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Search for Blueprints by a Keyword in an ordered mode", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/paged/meta-data/test?limit=5&sort=DATE", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "paged", "meta-data", "test" ], "query": [ { "key": "limit", "value": "5" }, { "key": "sort", "value": "DATE" } ] }, "description": "Lists all blueprint models by a matching keyword in any of the meta-data of the blueprint models in an ordered mode. Blueprint models are just returned if a whole keyword is matching, not just parts of it. Not case-sensitive. Used by CDS UI." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Publish a Blueprint Model", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "/home/jakob/Downloads/cba.zip" } ], "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/publish", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "publish" ] }, "description": "Validates the attached CBA file and saves it in CDS if validation was successful. CBA needs to be already enriched." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Search for a Blueprint by Tag", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/search/test", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "search", "test" ] }, "description": "Searches for all blueprint models which contain the specified input parameter in their tags. Blueprint models which contain just parts of the searched word in their tags are also returned." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Get Workflow Specification", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"blueprintName\" : \"vLB_CDS_KOTLIN\",\n \"workflowName\": \"config-assign\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/workflow-spec", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "workflow-spec" ] }, "description": "Get the workflow of a blueprint identified by Blueprint and workflow name. Inputs, outputs and data types of workflow is returned." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Get Workflows of a Blueprint", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/workflows/blueprint-name/vLB_CDS_KOTLIN/version/1.0.0", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "workflows", "blueprint-name", "vLB_CDS_KOTLIN", "version", "1.0.0" ] }, "description": "Get all available workflows of a Blueprint by its name and version." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Get a Blueprint Model by ID", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/416f241d-3ef9-4cb6-8834-956ae4f70b07", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "416f241d-3ef9-4cb6-8834-956ae4f70b07" ] }, "description": "Get a blueprint model by its internally created ID." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] }, { "name": "Delete a Blueprint Model by its ID", "protocolProfileBehavior": { "disabledSystemHeaders": {} }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "username", "value": "ccsdkapps", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "disabled": true }, { "key": "", "type": "text", "value": "", "disabled": true } ], "url": { "raw": "http://{{host}}:{{port}}/api/v1/blueprint-model/416f241d-3ef9-4cb6-8834-956ae4f70b07", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "blueprint-model", "416f241d-3ef9-4cb6-8834-956ae4f70b07" ] }, "description": "Delete a blueprint model a a given ID. ID is the internally created ID of blueprint, not the name of blueprint." }, "response": [ { "name": "CDS Bootstrap", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\r\n\"loadModelType\" : false,\r\n\"loadResourceDictionary\" : true,\r\n\"loadCBA\" : false\r\n}", "options": { "raw": {} } }, "url": { "raw": "http://localhost:8081/api/v1/blueprint-model/bootstrap", "protocol": "http", "host": [ "localhost" ], "port": "8081", "path": [ "api", "v1", "blueprint-model", "bootstrap" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "X-ONAP-RequestID", "value": "b73253b6-d2be-4701-bdb2-31fa66b79a01" }, { "key": "X-ONAP-InvocationID", "value": "b1a59296-fcf2-4435-b8de-9a2e9b9f4077" }, { "key": "X-ONAP-PartnerName", "value": "cds-controller" }, { "key": "Vary", "value": "Origin" }, { "key": "Vary", "value": "Access-Control-Request-Method" }, { "key": "Vary", "value": "Access-Control-Request-Headers" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "0" }, { "key": "Cache-Control", "value": "no-cache, no-store, max-age=0, must-revalidate" }, { "key": "Pragma", "value": "no-cache" }, { "key": "Expires", "value": "0" }, { "key": "X-Content-Type-Options", "value": "nosniff" }, { "key": "X-Frame-Options", "value": "DENY" }, { "key": "X-XSS-Protection", "value": "1 ; mode=block" }, { "key": "Referrer-Policy", "value": "no-referrer" } ], "cookie": [], "body": "" } ] } ], "description": "Manages all blueprint models which are available in CDS", "protocolProfileBehavior": {} }, { "name": "Resource configuration", "item": [ { "name": "Retrieve a resource configuration snapshot", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/configs", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "configs" ] }, "description": "Retrieve a config snapshot, identified by its Resource Id and Type. An extra 'format' parameter can be passed to tell what content-type is expected." }, "response": [] }, { "name": "Retrieve all resource configuration snapshots identified by a given resource_id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/configs/allByID", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "configs", "allByID" ] }, "description": "Retrieve all config snapshots, identified by its Resource Id, ordered by most recently created/modified date." }, "response": [] }, { "name": "Retrieve all resource configuration snapshots for a given resource type", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/configs/allByType", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "configs", "allByType" ] }, "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." }, "response": [] }, { "name": "Store a resource configuration snapshot identified by resourceId, resourceType, status", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/configs/PNF/1/RUNNING", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "configs", "PNF", "1", "RUNNING" ] }, "description": "Store a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE." }, "response": [] } ], "description": "Interaction with stored configurations", "protocolProfileBehavior": {} }, { "name": "Resource dictionary", "item": [ { "name": "Save a resource dictionary", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"name\": \"test-source\",\r\n \"dataType\": \"string\",\r\n \"entrySchema\": null,\r\n \"resourceDictionaryGroup\": \"default\",\r\n \"definition\": {\r\n \"tags\": \"oam-local-ipv4-address\",\r\n \"name\": \"test-source\",\r\n \"property\": {\r\n \"description\": \"test\",\r\n \"required\": null,\r\n \"type\": \"string\",\r\n \"status\": null,\r\n \"constraints\": null,\r\n \"metadata\": null,\r\n \"value\": null,\r\n \"input-param\": null,\r\n \"default\": null,\r\n \"entry_schema\": null,\r\n \"external-schema\": null\r\n },\r\n \"group\": \"default\",\r\n \"updated-by\": \"sample@onap.com\",\r\n \"sources\": {\r\n \"sdnc\": {\r\n \"description\": null,\r\n \"type\": \"source-rest\",\r\n \"metadata\": null,\r\n \"directives\": null,\r\n \"properties\": {\r\n \"type\": \"JSON\",\r\n \"endpoint-selector\": \"\",\r\n \"url-path\": \"test\",\r\n \"path\": \"/v4-assigned-ip-list/0/v4-ip-prefix\",\r\n \"input-key-mapping\": {\r\n \"service-instance-id\": \"service-instance-id\",\r\n \"network-role\": \"network-role\",\r\n \"v4-ip-type\": \"v4-ip-type\",\r\n \"vm-type\": \"vm-type\"\r\n },\r\n \"output-key-mapping\": {\r\n \"oam-local-ipv4-address\": \"v4-ip-prefix\"\r\n },\r\n \"key-dependencies\": [\r\n \"service-instance-id\",\r\n \"network-role\",\r\n \"v4-ip-type\",\r\n \"vm-type\"\r\n ]\r\n },\r\n \"attributes\": null,\r\n \"capabilities\": null,\r\n \"requirements\": null,\r\n \"interfaces\": null,\r\n \"artifacts\": null,\r\n \"copy\": null,\r\n \"node_filter\": null\r\n }\r\n }\r\n },\r\n \"description\": \"test\",\r\n \"tags\": \"oam-local-ipv4-address\",\r\n \"updatedBy\": \"sample@onap.com\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary" ] }, "description": "Save a resource dictionary by dictionary provided." }, "response": [] }, { "name": "Search for a resource dictionary", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "[\r\n \"pub_key\",\r\n \"hostname\"\r\n]", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary/by-names", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary", "by-names" ] }, "description": "Search for a resource dictionary by names provided." }, "response": [] }, { "name": "Save a resource dictionary", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"tags\": \"v4-ip-type, tosca.datatypes.Root, data_type\",\r\n \"name\": \"test-source\",\r\n \"group\":\"test\",\r\n \"property\" :{\r\n \"description\": \"test\",\r\n \"type\": \"string\"\r\n },\r\n \"updated-by\": \"sample@onap.com\",\r\n \"sources\": {\r\n \"default\": {\r\n \"type\": \"source-default\",\r\n \"properties\": {\r\n }\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary/api/v1/dictionary/definition", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary", "api", "v1", "dictionary", "definition" ] }, "description": "Save a resource dictionary by dictionary provided." }, "response": [] }, { "name": "Retrieve all resource dictionary groups", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary/resource_dictionary_group", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary", "resource_dictionary_group" ] }, "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." }, "response": [] }, { "name": "Search for a resource dictionary", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary/search/hostname", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary", "search", "hostname" ] }, "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." }, "response": [] }, { "name": "Search for a source mapping", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary/search/hostname", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary", "search", "hostname" ] }, "description": "Search for a source mapping." }, "response": [] }, { "name": "Retrieve a resource dictionary", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary/active-streams", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary", "active-streams" ] }, "description": "Retrieve a resource dictionary by name provided." }, "response": [] }, { "name": "Remove a resource dictionary", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "DELETE", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/dictionary/active-streams", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "dictionary", "active-streams" ] }, "description": "Remove a resource dictionary by name provided." }, "response": [] } ], "description": "Interaction with stored dictionaries", "protocolProfileBehavior": {} }, { "name": "Resource template", "item": [ { "name": "Store a resolved template w/ resolution-key", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "PAYLOAD DATA", "options": { "raw": { "language": "text" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/template/baseconfiguration/1.0.0/activate/7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "template", "baseconfiguration", "1.0.0", "activate", "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" ] }, "description": "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name and resolution key." }, "response": [] }, { "name": "Store a resolved template w/ resourceId and resourceType", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "PAYLOAD DATA", "options": { "raw": { "language": "text" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/template/baseconfiguration/1.0.0/activate/test/1", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "template", "baseconfiguration", "1.0.0", "activate", "test", "1" ] }, "description": "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name, resourceId and resourceType." }, "response": [] } ], "description": "Interaction with resolved templates", "protocolProfileBehavior": {} }, { "name": "Resources", "item": [ { "name": "Get all resolved resources using the resolution key", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/resources?bpVersion=1.0.0&artifactName=activate&bpName=baseconfiguration&resolutionKey=7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "resources" ], "query": [ { "key": "bpVersion", "value": "1.0.0" }, { "key": "artifactName", "value": "activate" }, { "key": "bpName", "value": "baseconfiguration" }, { "key": "resolutionKey", "value": "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" } ] }, "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date." }, "response": [] }, { "name": "Delete resources using resolution key", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "DELETE", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/resources?bpVersion=1.0.0&artifactName=activate&bpName=baseconfiguration&resolutionKey=7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "resources" ], "query": [ { "key": "bpVersion", "value": "1.0.0" }, { "key": "artifactName", "value": "activate" }, { "key": "bpName", "value": "baseconfiguration" }, { "key": "resolutionKey", "value": "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" } ] }, "description": "Delete all the resources associated to a resolution-key using blueprint metadata, artifact name and the resolution-key." }, "response": [] }, { "name": "Fetch a resource value using resolution key", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/resources/api/v1/resources/resource?bpVersion=1.0.0&artifactName=activate&bpName=baseconfiguration&resolutionKey=7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08&name=test", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "resources", "api", "v1", "resources", "resource" ], "query": [ { "key": "bpVersion", "value": "1.0.0" }, { "key": "artifactName", "value": "activate" }, { "key": "bpName", "value": "baseconfiguration" }, { "key": "resolutionKey", "value": "7cafa9f3-bbc8-49ec-8f25-fcaa6ac3ff08" }, { "key": "name", "value": "test" } ] }, "description": "Retrieve a stored resource value using the blueprint metadata, artifact name, resolution-key along with the name of the resource value to retrieve." }, "response": [] } ], "description": "Interaction with resolved resources", "protocolProfileBehavior": {} }, { "name": "Model Type Catalog", "item": [ { "name": "Save a model type", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"modelName\": \"test\",\r\n \"derivedFrom\": \"test\",\r\n \"definitionType\": \"data_type\",\r\n \"definition\": {},\r\n \"description\": \"Some test\",\r\n \"version\": \"1.0\",\r\n \"tags\": \"test\",\r\n \"updatedBy\": \"test\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "http://{{host}}:{{port}}/api/v1/model-type/", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "model-type", "" ] }, "description": "Save a model type by model type definition provided." }, "response": [] }, { "name": "Retrieve a list of model types", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/model-type/by-definition/data_type", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "model-type", "by-definition", "data_type" ] }, "description": "Retrieve a list of model types by definition type provided." }, "response": [] }, { "name": "Retrieve a list of model types", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/model-type/search/test", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "model-type", "search", "test" ] }, "description": "Retrieve a list of model types by tags provided." }, "response": [] }, { "name": "Retrieve a model type", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/model-type/test", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "model-type", "test" ] }, "description": "Retrieve a model type by name provided." }, "response": [] }, { "name": "Remove a model type", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "DELETE", "header": [], "url": { "raw": "http://{{host}}:{{port}}/api/v1/model-type/test", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "api", "v1", "model-type", "test" ] }, "description": "Remove a model type by name provided." }, "response": [] } ], "description": "Manages data types in CDS", "protocolProfileBehavior": {} }, { "name": "List all endpoints", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "ccsdkapps", "type": "string" }, { "key": "password", "value": "ccsdkapps", "type": "string" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "http://{{host}}:{{port}}/actuator/mappings", "protocol": "http", "host": [ "{{host}}" ], "port": "{{port}}", "path": [ "actuator", "mappings" ] }, "description": "Lists all available endpoints from blueprints processor API." }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "id": "ac0bd38e-a1ae-48ea-9a99-e09c59dada9a", "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "id": "ce5f2837-00f5-4dde-9a45-2460c6cebd12", "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "id": "59f58f5b-ee64-490b-be39-09983d888dd8", "key": "host", "value": "localhost" }, { "id": "284f1750-2dd3-4fa4-aade-cccd91d53cc7", "key": "port", "value": "8081" } ], "protocolProfileBehavior": {} }