{
  "opencollection": "1.0.0",
  "info": {
    "name": "ETSI ISG CIM / NGSI-LD API Entry Point Subscriptions API",
    "version": "latest"
  },
  "items": [
    {
      "info": {
        "name": "Subscriptions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "retrieveSubscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subscriptions/",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Pagination limit"
              }
            ]
          },
          "docs": "Retrieves the subscriptions available in an NGSI-LD system"
        },
        {
          "info": {
            "name": "createSubscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/subscriptions/",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Subscription within an NGSI-LD system"
        },
        {
          "info": {
            "name": "retrieveSubscriptionById",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ]
          },
          "docs": "Retrieves a specific Subscription from an NGSI-LD system"
        },
        {
          "info": {
            "name": "updateSubscription",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a specific Subscription within an NGSI-LD system"
        },
        {
          "info": {
            "name": "removeSubscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "Subscription Id"
              }
            ]
          },
          "docs": "Removes a specific Subscription from an NGSI-LD system"
        },
        {
          "info": {
            "name": "List Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/subscriptions",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of subscriptions to be retrieved"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Skip a number of subscriptions"
              },
              {
                "name": "options",
                "value": "",
                "type": "query",
                "description": "Options dictionary"
              }
            ]
          },
          "docs": "Returns a list of all the subscriptions present in the system.\nResponse:\n* Successful operation uses 200 OK\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n  more details."
        },
        {
          "info": {
            "name": "Create Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/subscriptions",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ]
          },
          "docs": "Creates a new subscription.\nThe subscription is represented by a JSON object as described at the beginning of this section.\nResponse:\n* Successful operation uses 201 Created\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n  more details."
        },
        {
          "info": {
            "name": "Retrieve Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v2/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "subscription Id."
              }
            ]
          },
          "docs": "The response is the subscription represented by a JSON object as described at the beginning of this\nsection.\nResponse:\n* Successful operation uses 200 OK\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n  more details."
        },
        {
          "info": {
            "name": "Update Subscription",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v2/subscriptions/:subscriptionId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "subscription Id."
              }
            ]
          },
          "docs": "Only the fields included in the request are updated in the subscription.\nResponse:\n* Successful operation uses 204 No Content\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n  more details."
        },
        {
          "info": {
            "name": "Delete subscription",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v2/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "subscription Id."
              }
            ]
          },
          "docs": "Cancels subscription.\nResponse:\n* Successful operation uses 204 No Content\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n  more details."
        }
      ]
    }
  ],
  "bundled": true
}