match lines for document

This block is part of the array group and was last modified in core v14.0.2.

match lines for document array v14.0.2

Returns all matching lines by guid for the given document. The input should contain a _meta.guid$code$ which will be returned and an array matches$code$ containing { key, value }$code$.


  
  
    Inpins
  
  
    
      
        
          Pin
          Pin
          Type
          Default
        
      
      
      
          linesrequired
lines to match. Example: [{ "_meta": { "guid": "example" }, "matches": [{ "key": "code", "value": "test" }] }]
          array
          
        

          overwritesrequired
overwrite lines by guid. Example: { "example": [{ "_meta": { "guid": "example_overwrite" }, "matches": [{ "key": "code", "value": "test2" }] }] }
          object
          
        

          documentrequired
the document to match with. Example: { "_meta": { "guid": "example" }, "code": "test" }
          object
          
        

          only check prefix
If set will only check the given match prefix and return true for all other matches
          value
          
        
      
    
  
  
  
    Outpins
  
  
    
      
        
          Pin
          Pin
          Type
          Example
        
      
      
      
            matches

            array

Pin	Pin	Type	Default
lines`required` lines to match. Example: `[{ "_meta": { "guid": "example" }, "matches": [{ "key": "code", "value": "test" }] }]`	`array`
overwrites`required` overwrite lines by guid. Example: `{ "example": [{ "_meta": { "guid": "example_overwrite" }, "matches": [{ "key": "code", "value": "test2" }] }] }`	`object`
document`required` the document to match with. Example: `{ "_meta": { "guid": "example" }, "code": "test" }`	`object`
only check prefix If set will only check the given match prefix and return true for all other matches	`value`

Pin	Pin	Type	Example
matches	`array`



  

  Core Releases
  
  
    
    
      v14.0.2
      This block was introduced in v14.0.2, click here to see the release notes.
    
    
  
  
  

  
  
  
    
    
      Back to array
      Return to the main group to view all sub-groups
    
    
  
  
  
    
    
      Back to array
      Return to the group to view all blocks within this group
    
    
  
  
            
            RUAL Docs is an integral component of the RUAL ecosystem

Cluster

Blocks

Deployment

Interfaces

Blueprints

Other

match lines for document

Core Releases