Class: SCIMMY.Messages.BulkResponse

Class: SCIMMY .Messages.BulkResponse

SCIM Bulk Response Message

Summary:

Encapsulates bulk operation results as BulkResponse messages for consumption by a client.

Provides a method to unwrap BulkResponse results into operation success status, and map newly created resource IDs to their BulkRequest bulkIds.

Usage

Instantiate a new SCIM BulkResponse message from the supplied Operations

                    
                        new SCIMMY.Messages.BulkResponse(request)

Since:: 1.0.0
Source:: src/lib/messages/bulkresponse.js, line 9

Parameters:

Name Type Description


                        request


    ~BulkOpResponse[]

results of performed operations if array


    Object

contents of the received BulkResponse message if object

Properties

Name	Type	Description
`Operations`	`~BulkOpResponse[]`	list of SCIM-compliant bulk operation results

Properties:

Name	Type	Description
`schemas`	`SCIMMY.Messages.BulkResponse.id[]`	list exclusively containing the SCIM BulkResponse message schema ID
`Operations`	`~BulkOpResponse[]`	list of BulkResponse operation results

Members

(static) id: "urn:ietf:params:scim:api:messages:2.0:BulkResponse"

SCIM BulkResponse Message Schema ID

Type:: {"urn:ietf:params:scim:api:messages:2.0:BulkResponse"}
Source:: src/lib/messages/bulkresponse.js, line 17

Methods

resolve() → {Map<String, (String|Boolean)>}

Resolve bulkIds of POST operations into new resource IDs

Source:: src/lib/messages/bulkresponse.js, line 79

Returns:

map of bulkIds to resource IDs if operation was successful, or false if not

Type:

{Map<String, (String|Boolean)>}

Type Definitions

BulkOpResponse

BulkResponse operation details for a given BulkRequest operation

Type:: {Object}
Source:: src/lib/messages/bulkresponse.js, line 27

Properties:

Name	Type	Description
`locationopt`	`String`	canonical URI for the target resource of the operation
`method`	`~ValidBulkMethods`	the HTTP method used for the requested operation
`bulkIdopt`	`String`	the transient identifier of a newly created resource, unique within a bulk request and created by the client
`versionopt`	`String`	resource version after operation has been applied
`status`	`~ResponseStatusCodes`	the HTTP response status code for the requested operation
`responseopt`	`Object`	the HTTP response body for the specified request operation

Constants

(inner) ResponseStatusCodes

BulkResponse operation response status codes

Values:: ["200","201","204","307","308","400","401","403","404","409","412","500","501"]
Source:: src/lib/messages/bulkresponse.js, line 21