GET api/config/form-models?endpoint={endpoint}&apiKey={apiKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
endpoint

string

Required

apiKey

string

Required

Body Parameters

None.

Response Information

Resource Description

FormModelResult
NameDescriptionTypeAdditional information
ModelNames

Collection of string

None.

ModelFields

Dictionary of string [key] and Collection of string [value]

None.

Error

boolean

None.

ErrorText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ModelNames": [
    "sample string 1",
    "sample string 2"
  ],
  "ModelFields": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "Error": true,
  "ErrorText": "sample string 2"
}

application/xml, text/xml

Sample:
<FormModelResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AF.Activities.AIAssistedOCR">
  <Error>true</Error>
  <ErrorText>sample string 2</ErrorText>
  <ModelFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </ModelFields>
  <ModelNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ModelNames>
</FormModelResult>