Qodex.ai

UIMData Service.

POST {{baseUrl}}/session/services/uimdata

The UimData Real-Time Service will provide either UIM (Unified Indexing Model) data population or validation or both population and validation. The population and validation rules referenced below are developed in the Designer when constructing a Document Type. Please see the Designer documentation for more information about rules and Document Types.

Service Properties

  • Env - Metadata environment identifier. Value is one of D, T or P. Default value is P.

Number of Request Items

This Real-Time Service supports one or more items.

Values Per Request Item

  • Command - String. Valid values:

    • Validate - UimData is validated as per validation rules,
    • Populate - UimData fields are populated using population rules, or
    • PopulateAndValidate - UimData fields are populated using population rules and then the data is validated per data validation rules.

  • TriggerReference - String. Name of the field that is used as a population trigger or population target. Used only for Populate or PopulateAndValidate commands. If this is empty or not provided, then the service will run all the rules on the supplied UimData. If it is populated, then it will only run rules that are not one-time rules.

  • TriggerKind - String. One of the following values. Used only for Populate or PopulateAndValidate commands.

    • Calculate - The first expression population rule where TriggerReference is used as the target field is run. This can also be an array field name with a valid row index specified in PopulateTriggerRow,
    • Lookup - All population rules of type DatabaseLookup are run in the specified order, where the TriggerReference is one of the trigger fields. This can also be an array field name with a valid row index specified in PopulateTriggerRow, or
    • PopulateOptions - The first DatebaseLookup rule is run where TriggerReference is one of the trigger fields and the Choice values are populated by the first two columns of the result set. This can also be an array field name with a valid row index specified in PopulateTriggerRow.

  • PopulateTriggerRow - Integer. This is a zero based row index for array field based population. This property is ignored if no field name was supplied in the triggerReference property or if the field name supplied is not an array field. The operation will also fail if the index supplied for this property is invalid for the supplied array field name.

  • UimData - Object. This is a UIM data information object that you want the service to use for performing the command.

Files Per Request Item

No files are necessary or used.

Request Body

{"requestItems"=>[{"nodeId"=>1, "values"=>[{"name"=>"Command", "value"=>"Populate"}, {"name"=>"TriggerReference", "value"=>"ID"}, {"name"=>"TriggerKind", "value"=>"Lookup"}, {"name"=>"UimData", "value"=>{"docType"=>"Employee", "locale"=>"en-US", "flaggedReason"=>nil, "extractionId"=>"3aff08999e844ff6a31aff002b0fcb4a", "nodeList"=>[{"name"=>"ID", "isArray"=>false, "indexFieldType"=>"string", "labelText"=>"ID", "isRequired"=>false, "controlType"=>"TextBox", "data"=>[{"arrayIndex"=>0, "value"=>"1234", "fieldError"=>nil, "mustConfirm"=>false, "choices"=>nil}]}, {"name"=>"Name", "isArray"=>false, "indexFieldType"=>"string", "labelText"=>"Name", "isRequired"=>false, "controlType"=>"TextBox", "data"=>[{"arrayIndex"=>0, "value"=>"", "fieldError"=>nil, "mustConfirm"=>false, "choices"=>nil, "locationRect"=>nil, "pageId"=>0, "confidence"=>100}]}]}}]}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"returnStatus":{"status":200,"code":"OK0000","message":"","server":"WS-S7699312da37548f4a2bf9921c4a66d90"},"id":"REQ1","serviceName":"UimData","executionMilliSeconds":847,"licenseUsedPercent":0,"resultItems":[{"nodeId":1,"errorCode":"","errorMessage":"","values":[{"name":"UimData","value":{"docType":"Employee","locale":"en-US","flaggedReason":null,"extractionId":"3aff08999e844ff6a31aff002b0fcb4a","nodeList":[{"name":"ID","isArray":false,"indexFieldType":"string","labelText":"ID","isRequired":false,"controlType":"TextBox","data":[{"arrayIndex":0,"value":"1234","fieldError":null,"mustConfirm":false,"choices":null,"locationRect":{"left":0,"top":0,"width":0,"height":0},"pageId":0,"confidence":100}]},{"name":"Name","isArray":false,"indexFieldType":"string","labelText":"Name","isRequired":false,"controlType":"TextBox","data":[{"arrayIndex":0,"value":"John Doe","fieldError":null,"mustConfirm":false,"choices":null,"locationRect":{"left":0,"top":0,"width":0,"height":0},"pageId":0,"confidence":100}]}]}}]}]}