{
  "opencollection": "1.0.0",
  "info": {
    "name": "ETSI ISG CIM / NGSI-LD API Entry Point Batch Operations API",
    "version": "latest"
  },
  "items": [
    {
      "info": {
        "name": "Batch Operations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "batchEntityCreation",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/entityOperations/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Batch Entity creation"
        },
        {
          "info": {
            "name": "batchEntityUpdate",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/entityOperations/update",
            "params": [
              {
                "name": "options",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Batch Entity update"
        },
        {
          "info": {
            "name": "batchEntityUpsert",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/entityOperations/upsert",
            "params": [
              {
                "name": "options",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Batch Entity upsert"
        },
        {
          "info": {
            "name": "batchEntityDelete",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/entityOperations/delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Batch Entity delete"
        },
        {
          "info": {
            "name": "Update",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/op/update",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "options",
                "value": "",
                "type": "query",
                "description": "Options dictionary"
              }
            ]
          },
          "docs": "This operation allows to create, update and/or delete several entities in a single batch operation.\nThe payload is an object with two properties:\n+ `actionType`, to specify the kind of update action to do: either `append`, `appendStrict`, `update`,\n  `delete`, or `replace`.\n+ `entities`, an array of entities, each entity specified using the JSON entity representation format\n  (described in the section \"JSON Entity Representation\").\nThis operation is split in as many individual operations as enti"
        },
        {
          "info": {
            "name": "Query",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/op/query",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of entities to be retrieved."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Skip a number of records."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Criteria for ordering results.\nSee \"Ordering Results\" section for details."
              },
              {
                "name": "options",
                "value": "",
                "type": "query",
                "description": "Options dictionary"
              }
            ]
          },
          "docs": "The response payload is an Array containing one object per matching entity, or an empty array `[]` if \nno entities are found. The entities follow the JSON entity representation format\n(described in the section \"JSON Entity Representation\").\nThe payload may contain the following elements (all of them optional):\n+ `entities`: a list of entites to search for. Each element is represented by a JSON object with the\n  following elements:\n    + `id` or `idPattern`: Id or pattern of the affected entities"
        },
        {
          "info": {
            "name": "Notify",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v2/op/notify",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "options",
                "value": "",
                "type": "query",
                "description": "Options dictionary"
              }
            ]
          },
          "docs": "This operation is intended to consume a notification payload so that all the entity data included by such notification is persisted, overwriting if necessary.\nThis operation is useful when one NGSIv2 endpoint is subscribed to another NGSIv2 endpoint (federation scenarios). \nThe request payload must be an NGSIv2 notification payload. \nThe behaviour must be exactly the same as `POST /v2/op/update` with `actionType` equal to `append`.\nResponse code:\n* Successful operation uses 200 OK\n* Errors use a"
        }
      ]
    }
  ],
  "bundled": true
}