Class: SCIMMY.Messages.PatchOp
SCIM Patch Operation Message
Description
Summary:
- Parses PatchOp messages, making sure all specified "Operations" are valid and conform with the SCIM protocol.
- Provides a method to atomically apply PatchOp operations to a resource instance, handling any exceptions that occur along the way.
Usage
Instantiate a new SCIM Patch Operation Message with relevant details
new SCIMMY.Messages.PatchOp(request)
Parameters:
| Name | Type | Description |
|---|---|---|
request
|
Object |
contents of the patch operation request being performed |
Properties:
| Name | Type | Description |
|---|---|---|
Operations
|
Object[] |
list of SCIM-compliant patch operations to apply to the given resource |
Methods
(async) apply(resource, finaliseopt) → {SCIMMY.Types.Schema, SCIMMY.Types.Schema[]}
Apply patch operations to a resource as defined by the PatchOp instance
Parameters:
| Name | Type | Description |
|---|---|---|
resource
|
SCIMMY.Types.Schema |
the schema instance the patch operation will be performed on |
finaliseopt
|
function |
method to call when all operations are complete, to feed target back through model |
Returns:
an instance of the resource modified as per the included patch operations
Constants
(inner) ValidPatchOperations: String[]
List of valid SCIM patch operations
- Values:
["add","remove","replace"]- Type:
- {String[]}