Class: SCIMMY.Messages.BulkRequest
SCIM Bulk Request Message
Description
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 BulkResponse message from the supplied BulkRequest
new SCIMMY.Messages.BulkRequest(request, maxOperationsopt)
- Since:
- 1.0.0
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
request
|
Object |
contents of the BulkRequest operation being performed Properties
|
|||||||||
maxOperationsopt
|
Number |
maximum number of operations supported in the request, as specified by the service provider |
Properties:
| Name | Type | Description |
|---|---|---|
Operations
|
Object[] |
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
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
Constants
(inner) ValidBulkMethods: String[]
List of valid HTTP methods in a SCIM bulk request operation
- Values:
["POST","PUT","PATCH","DELETE"]- Type:
- {String[]}