GET api/utils/modifiers Authentication required

Use this method to fetch all the record modifiers available to extracts. Modifiers run between record load and file write and can add columns to the output. The list reflects the modifiers registered by the Processing.Extracts service at startup.

Request

No URI or Body Parameter required

Response

Returns all the active modifiers

Output : array of objects (See Model)

Ouput Sample

  • application/json, text/json :
    • [ { "name": "sample string 1", "displayName": "sample string 2", "description": "sample string 3", "requiredFields": [ "sample string 1", "sample string 2" ], "addedColumns": [ { "name": "sample string 1", "anchor": { "columnName": "sample string 1", "position": "sample string 2" } }, { "name": "sample string 1", "anchor": { "columnName": "sample string 1", "position": "sample string 2" } } ] }, { "name": "sample string 1", "displayName": "sample string 2", "description": "sample string 3", "requiredFields": [ "sample string 1", "sample string 2" ], "addedColumns": [ { "name": "sample string 1", "anchor": { "columnName": "sample string 1", "position": "sample string 2" } }, { "name": "sample string 1", "anchor": { "columnName": "sample string 1", "position": "sample string 2" } } ] } ]
  • application/xml, text/xml :
    • <ArrayOfRecordModifierModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kapitol.Registered.API.Models"> <RecordModifierModel> <AddedColumns> <RecordModifierColumnModel> <Anchor> <ColumnName>sample string 1</ColumnName> <Position>sample string 2</Position> </Anchor> <Name>sample string 1</Name> </RecordModifierColumnModel> <RecordModifierColumnModel> <Anchor> <ColumnName>sample string 1</ColumnName> <Position>sample string 2</Position> </Anchor> <Name>sample string 1</Name> </RecordModifierColumnModel> </AddedColumns> <Description>sample string 3</Description> <DisplayName>sample string 2</DisplayName> <Name>sample string 1</Name> <RequiredFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </RequiredFields> </RecordModifierModel> <RecordModifierModel> <AddedColumns> <RecordModifierColumnModel> <Anchor> <ColumnName>sample string 1</ColumnName> <Position>sample string 2</Position> </Anchor> <Name>sample string 1</Name> </RecordModifierColumnModel> <RecordModifierColumnModel> <Anchor> <ColumnName>sample string 1</ColumnName> <Position>sample string 2</Position> </Anchor> <Name>sample string 1</Name> </RecordModifierColumnModel> </AddedColumns> <Description>sample string 3</Description> <DisplayName>sample string 2</DisplayName> <Name>sample string 1</Name> <RequiredFields xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </RequiredFields> </RecordModifierModel> </ArrayOfRecordModifierModel>