SOL002 - VNF Indicator interface 2.4.1.postman_collection.json 7.79 KB
Newer Older
{
	"info": {
		"_postman_id": "558431d6-7a0c-4935-8ed1-7a98a1a0c046",
		"name": "SOL002 - VNF Indicator interface 2.4.1",
		"description": "DRAFT - SOL002 - VNF Indicator interface\nThis API allows the EM/VNF to provide information on value changes of VNF related indicators.  VNF related indicators are declared in the VNFD.\nIMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence.\nPlease report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis\n",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "indicators",
			"description": "Folder for indicators",
			"item": [
				{
					"name": "Query multiple indicators",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "GET",
						"header": [
							{
								"key": "Accept",
								"value": "application/json"
							},
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "{{Authorization}}",
								"value": "{{Authorization}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfind/v1/indicators",
							"protocol": "{{scheme}}",
							"host": [
								"{{host}}{{port}}"
							],
							"port": "",
							"path": [
								"{{uri_prefix}}vnfind",
								"v1",
								"indicators"
							]
						},
						"description": "The GET method queries multiple VNF indicators."
					},
					"response": []
				},
				{
					"name": "Query multiple indicators related to a VNF instance.",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "GET",
						"header": [
							{
								"key": "Accept",
								"value": "application/json"
							},
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "Authorization",
								"value": "{{Authorization}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfind/v1/indicators/{{vnfInstanceId2}}",
							"protocol": "{{scheme}}",
							"host": [
								"{{host}}{{port}}"
							],
							"port": "",
							"path": [
								"{{uri_prefix}}vnfind",
								"v1",
								"indicators",
								"{{vnfInstanceId2}}"
							]
						},
						"description": "Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters.\n"
					},
					"response": []
				},
				{
					"name": "Read an inidividual VNF indicator.",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "GET",
						"header": [
							{
								"key": "Accept",
								"value": "application/json"
							},
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "Authorization",
								"value": "{{Authorization}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfind/v1/indicators/{{vnfInstanceId2}}/{{indicatorId2}}",
							"protocol": "{{scheme}}",
							"host": [
								"{{host}}{{port}}"
							],
							"port": "",
							"path": [
								"{{uri_prefix}}vnfind",
								"v1",
								"indicators",
								"{{vnfInstanceId2}}",
								"{{indicatorId2}}"
							]
						},
						"description": "The GET method reads an individual VNF indicator.\nNOTE: This identifier can be retrieved from the resource referenced by the \"Location\" HTTP header in the response to a  POST request creating a new VNF instance resource. It can also be retrieved from the \"id\" attribute in the payload body  of that response.\n"
					},
					"response": []
				}
			]
		},
		{
			"name": "subscriptions",
			"description": "Folder for subscriptions",
			"item": [
				{
					"name": "Query multiple subscriptions.",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "GET",
						"header": [
							{
								"key": "Accept",
								"value": "application/json"
							},
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "Authorization",
								"value": "{{Authorization}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfind/v1/subscriptions",
							"protocol": "{{scheme}}",
							"host": [
								"{{host}}{{port}}"
							],
							"port": "",
							"path": [
								"{{uri_prefix}}vnfind",
								"v1",
								"subscriptions"
							]
						},
						"description": "Service Unavailable\nThe GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations.\n"
					},
					"response": []
				},
				{
					"name": "Create a new subscription to VNF indicator change notifications",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "POST",
						"header": [
							{
								"key": "Accept",
								"value": "application/json"
							},
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "Authorization",
								"value": "{{Authorization}}"
							}
						],
						"body": {
							"mode": "raw",
							"raw": "{\n\t\"callbackUri\" : \"http://10.100.6.57:9988/notify\"\n}"
						},
						"url": {
							"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfind/v1/subscriptions",
							"protocol": "{{scheme}}",
							"host": [
								"{{host}}{{port}}"
							],
							"port": "",
							"path": [
								"{{uri_prefix}}vnfind",
								"v1",
								"subscriptions"
							]
						},
						"description": "Create a new subscription"
					},
					"response": []
				},
				{
					"name": "Read an individual subscription.",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "GET",
						"header": [
							{
								"key": "Accept",
								"value": "application/json"
							},
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "Authorization",
								"value": "{{Authorization}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfind/v1/subscriptions/{{subscriptionId}}",
							"protocol": "{{scheme}}",
							"host": [
								"{{host}}{{port}}"
							],
							"port": "",
							"path": [
								"{{uri_prefix}}vnfind",
								"v1",
								"subscriptions",
								"{{subscriptionId}}"
							]
						},
						"description": "Service Unavailable\nThis resource represents an individual subscription. The client can use this resource to  read and to terminate a subscription to notifications related to VNF indicator value changes.\n"
					},
					"response": []
				},
				{
					"name": "Delete a subscription",
					"request": {
						"auth": {
							"type": "noauth"
						},
						"method": "DELETE",
						"header": [
							{
								"key": "Accept",
								"value": "application/json"
							},
							{
								"key": "Content-Type",
								"value": "application/json"
							},
							{
								"key": "Authorization",
								"value": "{{Authorization}}"
							}
						],
						"body": {},
						"url": {
							"raw": "{{scheme}}://{{host}}{{port}}/{{uri_prefix}}vnfind/v1/subscriptions/{{subscriptionId}}",
							"protocol": "{{scheme}}",
							"host": [
								"{{host}}{{port}}"
							],
							"port": "",
							"path": [
								"{{uri_prefix}}vnfind",
								"v1",
								"subscriptions",
								"{{subscriptionId}}"
							]
						},
						"description": "Terminate an individual subscription."
					},
					"response": []
				}
			]
		}
	]
}