SCIMMY: Class - SCIMMY.Messages.BulkRequest

Class: SCIMMY .Messages.BulkRequest

SCIM Bulk Request Message

Summary:

Parses BulkRequest messages, making sure "Operations" have been specified, and conform with the SCIM protocol.

Provides a method to apply BulkRequest operations and return the results as a BulkResponse.

Usage

Instantiate a new SCIM BulkRequest message from the supplied operations

                    
                        new SCIMMY.Messages.BulkRequest(request, maxOperationsopt)

Since:: 1.0.0
Source:: src/lib/messages/bulkrequest.js, line 21

Parameters:

Name Type Description


                        request


    Object

contents of the BulkRequest operation being performed

Properties

Name	Type	Description
`Operations`	`~BulkOpOperation[]`	list of SCIM-compliant bulk operations to apply
`failOnErrorsopt`	`Number`	number of error results to encounter before aborting any following operations


                        maxOperationsopt


    Number

maximum number of operations supported in the request, as specified by the service provider

Properties:

Name	Type	Description
`Operations`	`~BulkOpOperation[]`	list of operations in this BulkRequest instance
`failOnErrorsopt`	`Number`	number of error results a service provider should tolerate before aborting any following operations

Methods

(async) apply(resourceTypesopt, ctxopt) → {SCIMMY.Messages.BulkResponse}

Apply the operations specified by the supplied BulkRequest and return a new BulkResponse message

Source:: src/lib/messages/bulkrequest.js, line 88

Parameters:

Name	Type	Description
`resourceTypesopt`	`SCIMMY.Types.Resource[]`	resource type classes to be used while processing bulk operations, defaults to declared resources
`ctxopt`	`*`	any additional context information to pass to the ingress, egress, and degress handlers

Returns:

a new BulkResponse Message instance with results of the requested operations

Type:

{SCIMMY.Messages.BulkResponse}

Type Definitions

BulkOpOperation

BulkRequest operation details

Type:: {Object}
Source:: src/lib/messages/bulkrequest.js, line 36

Properties:

Name	Type	Description
`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
`pathopt`	`String`	the resource's relative path to the SCIM service provider's root
`dataopt`	`Object`	the resource data as it would appear for the corresponding single SCIM HTTP request

Constants

(inner) ValidBulkMethods

List of valid HTTP methods in a SCIM bulk request operation

Values:: ["POST","PUT","PATCH","DELETE"]
Source:: src/lib/messages/bulkrequest.js, line 6