FieldDefinitionsForDocument

Field Definitions from iConnector Server

 

If the propety  ‘Get Field Metadata From Server’ setting in Admin Panel - Document Type is ON, field definitions will be retrieved from the iConnector Server component.

To facilitate this, the Server.Connector should provide the Web Service Method FieldDefinitionsForDocument.

 

An example of the HTTP headers:

POST https://Server/ConnectorService.svc/json/FieldDefinitionsForDocument 
     HTTP/1.1
Content-Type: application/json; encoding=utf-8
Accept: application/json
Accept-Charset: utf-8
Accept-Language: nl-NL,nl;q=0.8,en-US;q=0.5,en;q=0.3
Host: Server
Content-Length: 339
Expect: 100-continue

 

An example of the JSON body:

{
    "Configuration": {
        "ConfigurationUniqueId": "e7d45bd6-1c1c-4af7-b389-121e18a2e4b8",
        "Name": "JSON Test",
        "CustomConfiguration": null,
        "CustomData": "customer-id-2345"
    },
    "DocumentType": {
        "DocumentTypeUniqueId": "6794225c-97ce-48ea-b135-9150741a9a02",
        "Name": "DynamicFieldTest",
        "SaveNameTemplate": null,
        "DocumentFormat": "PDF",
        "CustomConfiguration": null
    }
}

 

An example of the JSON response:

[
    {
        "Name": "CustomerID",
        "DisplayName": "Customer number",
        "FieldDatatype": "number",
        "DefaultValue": null,
        "IsRequired": true,
        "LookupValues": null,
        "ServerLookupKey": null
    },
    {
        "Name": "Department",
        "DisplayName": "Department",
        "FieldDatatype": "lookup",
        "DefaultValue": null,
        "IsRequired": true,
        "LookupValues": [
            {
                "DisplayValue": "Department A",
                "Value": "DepartmentA"
            },
            {
                "DisplayValue": "Department B",
                "Value": "DepartmentB"
            }],
        "ServerLookupKey": null
    },
    {
        "Name": "Employee",
        "DisplayName": "Employee",
        "FieldDatatype": "lookup",
        "DefaultValue": null,
        "IsRequired": false,
        "LookupValues": null,
        "ServerLookupKey": "Employee"
    }
]
Create your own Knowledge Base