Skip to main content

How to Create a Text Layout in Adeptia Connect (AC4) Using Connect API?

Dhamarakonda Nikhil
  • Updated

Prerequisites:

Before using any SchemaUI APIs, you must generate an access token (JWT) using the Adeptia authentication API.

Generate Access Token API

POST   https://<domain>/rest/security/authenticate

Headers

KeyValue
Content-Type     application/json

Request Body:  raw format, JSON type

{
 "userId": "<your_user_id>",
 "password": "<your_password>"
}

Response Example:

{
 "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6..."
}

 

Overview: Two-API Process

StepAPIPurpose
Step 1/SchemaUI/rest/advschema/xsd/createGenerates XSD structure for Text Layout
Step 2/SchemaUI/rest/advschema/createCreates an actual Text Schema object in Adeptia

 

STEP 1 — Generate the XSD (Layout Structure)  Endpoint

Method - POST   https://<domain>/SchemaUI/rest/advschema/xsd/create
KeyValue
CookiesACCESS_TOKEN=<*>
Content-Typeapplication/json

 

Request Body: raw format, JSON type 

Sample JSON format  

{"json":{"category":"Schema","type":"text","version":"1.0","sequentially":true},"schema":{"defineMode":"data","entityName":"TestAPI_mANUAL1","schemaType":"text","project":"Project:    11484550701988","entityId":"","description":"TestAPI_mANUAL1","permissionMask":"777","userOwner":"","fieldSeparator":"","encodingUsed":"UTF-8"},"appInfo":{"XSDVersion":"1","sheets":"CSV","startRowNumber":"1","bottomRowSkipCount":"0","fieldSeparator":"|","recordSeparator":"\\r\\n","allowLessFields":false,"allowIgnoreCase":false,"allowDiscontinousOrder":false,"removeLastNewLineSeperator":false,"removeInvalidChar":false,"enclosedChar":"","arrayLayout":false},"sheet":[{"section":[{"name":"Table","sectiontype":"table","ignoreBlankRows":"0","uniqueFieldNames":"","fields":[{"originalName":"column1","name":"column1","type":"string","format":"AAAAAAAA","subFormat":"","dataMode":"plainText","id":2370,"newObject":"true","sheetName":"CSV","actualTableName":"Table","tableName":"Table","sectionType":"Table"},{"originalName":"column2","name":"column2","type":"string","format":"AAAAAAAA","subFormat":"","dataMode":"plainText","id":2371,"newObject":"true","sheetName":"CSV","actualTableName":"Table","tableName":"Table","sectionType":"Table"},{"originalName":"column3","name":"column3","type":"string","format":"AAAAAAAA","subFormat":"","dataMode":"plainText","id":2372,"newObject":"true","sheetName":"CSV","actualTableName":"Table","tableName":"Table","sectionType":"Table"},{"originalName":"column4","name":"column4","type":"string","format":"AAAAAAAA","subFormat":"","dataMode":"plainText","id":2373,"newObject":"true","sheetName":"CSV","actualTableName":"Table","tableName":"Table","sectionType":"Table"},{"originalName":"column5","name":"column5","type":"string","format":"AAAAAAAA","subFormat":"","dataMode":"plainText","id":2374,"newObject":"true","sheetName":"CSV","actualTableName":"Table","tableName":"Table","sectionType":"Table"}]}]}],"dataFilePresent":false,"filePath":"","html":"%5B%7B%22pageName%22%3Anull%2C%22html%22%3A%22%22%7D%5D"}

 

Response Example:

XML Format

{"filePath":"/shared/web/AdvanceSchemaRepository/temp/f26d04b7-259f-4b05-a5e0-5fce68da801d/TestAPI_mANUAL1.json","xsd":"
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n
<xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\">\n\t
    <xs:element name=\"Root\">\n\t\t
        <xs:annotation>\n\t\t\t
            <xs:appinfo>\n\t\t\t\t
                <XSDVersion>1</XSDVersion>\n\t\t\t\t
                <fieldSeparator>|</fieldSeparator>\n\t\t\t\t
                <recordSeparator>\\r\\n</recordSeparator>\n\t\t\t\t
                <allowDiscontinousOrder>false</allowDiscontinousOrder>\n\t\t\t\t
                <allowIgnoreCase>false</allowIgnoreCase>\n\t\t\t\t
                <allowMoreFields>false</allowMoreFields>\n\t\t\t\t
                <allowLessFields>false</allowLessFields>\n\t\t\t\t
                <removeLastNewLineSeperator>false</removeLastNewLineSeperator>\n\t\t\t\t
                <removeInvalidChar>false</removeInvalidChar>\n\t\t\t\t
                <enclosedChar></enclosedChar>\n\t\t\t\t
                <startRowNumber>1</startRowNumber>\n\t\t\t\t
                <skippedBottomRows>0</skippedBottomRows>\n\t\t\t\t
                <arrayLayout>false</arrayLayout>\n\t\t\t
            </xs:appinfo>\n\t\t
        </xs:annotation>\n\t\t
        <xs:complexType>\n\t\t\t
            <xs:sequence>\n\t\t\t\t
                <xs:element name=\"Record\" minOccurs=\"1\" maxOccurs=\"unbounded\">\n
                    <xs:complexType>
                        <xs:sequence>\n
                            <xs:element name=\"column1\" minOccurs=\"0\" maxOccurs=\"1\" type=\"xs:string\">\n
                                <xs:annotation>
                                    <xs:appinfo>
                                        <format>AAAAAAAA</format>
                                        <originalName>
                                            <![CDATA[column1]]>
                                        </originalName>
                                        <parent> </parent>\n
                                    </xs:appinfo>
                                </xs:annotation>
                            </xs:element>\n
                            <xs:element name=\"column2\" minOccurs=\"0\" maxOccurs=\"1\" type=\"xs:string\">\n
                                <xs:annotation>
                                    <xs:appinfo>
                                        <format>AAAAAAAA</format>
                                        <originalName>
                                            <![CDATA[column2]]>
                                        </originalName>
                                        <parent> </parent>\n
                                    </xs:appinfo>
                                </xs:annotation>
                            </xs:element>\n
                            <xs:element name=\"column3\" minOccurs=\"0\" maxOccurs=\"1\" type=\"xs:string\">\n
                                <xs:annotation>
                                    <xs:appinfo>
                                        <format>AAAAAAAA</format>
                                        <originalName>
                                            <![CDATA[column3]]>
                                        </originalName>
                                        <parent> </parent>\n
                                    </xs:appinfo>
                                </xs:annotation>
                            </xs:element>\n
                            <xs:element name=\"column4\" minOccurs=\"0\" maxOccurs=\"1\" type=\"xs:string\">\n
                                <xs:annotation>
                                    <xs:appinfo>
                                        <format>AAAAAAAA</format>
                                        <originalName>
                                            <![CDATA[column4]]>
                                        </originalName>
                                        <parent> </parent>\n
                                    </xs:appinfo>
                                </xs:annotation>
                            </xs:element>\n
                            <xs:element name=\"column5\" minOccurs=\"0\" maxOccurs=\"1\" type=\"xs:string\">\n
                                <xs:annotation>
                                    <xs:appinfo>
                                        <format>AAAAAAAA</format>
                                        <originalName>
                                            <![CDATA[column5]]>
                                        </originalName>
                                        <parent> </parent>\n
                                    </xs:appinfo>
                                </xs:annotation>
                            </xs:element>\n
                        </xs:sequence>\n
                        <xs:attribute name=\"recordNumber\" type=\"xs:string\" use=\"required\"/>\n
                    </xs:complexType>
                </xs:element>\n\t\t\t
            </xs:sequence>\n\t\t
        </xs:complexType>\n\t
    </xs:element>\n
</xs:schema>"}
 
 
 
STEP 2 — Create the Actual Text Schema Endpoint
 
POST https://<domain>/SchemaUI/rest/advschema/create
KeyValue
CookiesACCESS_TOKEN <access_token>
Content-Typeapplication/json

 

Header: raw format, JSON type

{"schemaData":{"TextSchema":{"advancedSchema":true,"headerPresent":true,"nameValueMap":null,"encodingUsed":"UTF-8","password":"","json":null,"xsd":"\n\n\t\n\t\t\n\t\t\t\n\t\t\t\t1\n\t\t\t\t|\n\t\t\t\t\\r\\n\n\t\t\t\tfalse\n\t\t\t\tfalse\n\t\t\t\tfalse\n\t\t\t\tfalse\n\t\t\t\tfalse\n\t\t\t\tfalse\n\t\t\t\t\n\t\t\t\t1\n\t\t\t\t0\n\t\t\t\tfalse\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\t\n\n\nAAAAAAAA \n\n\nAAAAAAAA \n\n\nAAAAAAAA \n\n\nAAAAAAAA \n\n\nAAAAAAAA \n\n\n\n\n\t\t\t\n\t\t\n\t\n","advanceXsd":null,"allowLessFields":false,"allowIgnoreCase":false,"arrayLayout":false,"skippedBottomRows":"0","startRowNumber":"1","allowDiscontinousOrder":false,"passwordProtected":false,"repositoryLocation":null,"xsdFilePath":"","recordService":null,"previousVersion":"","permissionMask":"770","description":"TestAPI_mANUAL4","entityName":"TestAPI_mANUAL4","entityFolderPath":"/shared/web/AdvanceSchemaRepository/temp/f26d04b7-259f-4b05-a5e0-5fce68da801d/TestAPI_mANUAL4.json","project":"Project:11484550701988","encloseFieldsInQuotes":false,"quotesHandlingOn":false,"removeLastNewLineSeperator":false,"removeInvalidChar":false,"reusable":true}},"schemaType":"text","filePath":"/shared/web/AdvanceSchemaRepository/temp/f26d04b7-259f-4b05-a5e0-5fce68da801d/TestAPI_mANUAL2.json","fileChange":false}
 
 
Response Example: 
JSON format
{
    "id": "1443158700689391616",
    "entityName": "TestAPI_mANUAL4",
    "serviceName": "TextSchema",
    "filePath": [
        "/shared/web/AdvanceSchemaRepository/1443158700689391616/TestAPI_mANUAL2.json"
    ]
}
 
Note: Make sure the file path is the same in both API's 
 
The Text Layout is visible on the Connect screen.


 

Related articles

Comments

0 comments

Article is closed for comments.