Commit bfe830ae authored by Marco Cavalli's avatar Marco Cavalli
Browse files

Update batch operation response structure in NGSI-LD API

parent 91b9e65b
Loading
Loading
Loading
Loading
+25 −12
Original line number Diff line number Diff line
@@ -1546,21 +1546,34 @@ paths:
          allOf:
            - $ref: '#/components/responses/MultiStatus.BatchOperationResult'
          description: |
            If only some or none of the entities have been successfully created, a response body containing the
            result of each operation contained in the batch is returned in a BatchOperationResult structure.
            It contains two arrays. The first array ('success') contains the URIs of the successfully created entities,
            while the second array ('errors') contains information about the error for each
            of the entities that could not be created. There is no restriction
            as to the order of the Entity Ids in the arrays.
            If only some or none of the entities have
            been successfully updated, a response
            body containing the result of each operation
            contained in the batch is returned in a
            BatchOperationResult structure. It contains
            two arrays. The first array ('success')
            contains the URIs of the successfully
            updated entities, while the second array
            ('errors') contains information about the
            error for each of the entities that could not
            be updated. There is no restriction as to the
            order of the Entity Ids in the arrays.

            If any of the entities matches to a registration, the relevant parts of the request
            are forwarded as a distributed operation.
            If any of the entities matches to a
            registration, the relevant parts of the
            request are forwarded as a distributed
            operation.

            In the case when an error response is received back from any distributed operation,
            a response body containing the result returned from each registration
            is returned in a BatchOperationResult structure.
            In the case when an error response is
            received back from any distributed
            operation, a response body containing the
            result returned from each registration is
            returned in a BatchOperationResult
            structure.

            Errors can occur whenever a distributed operation is unsupported, fails or times out, see clause 6.3.17.
            Errors can occur whenever a distributed
            operation is unsupported, fails or times out,
            see clause 6.3.17. 
        '400':
          $ref: '#/components/responses/BadRequest'
  /entityOperations/delete: