Parse by Template Defined as an Object Leave feedback
On this page
This REST API allows us to extract document’s fields and tables defined in a template object passed as a method parameter.
The following example demonstrates how to extract data from a source document by a user-defined template. Here you can see how to parse text fields by regular expressions and a table inside the document.
The following GroupDocs.Parser Cloud REST API resource has been used in the Parse by Template defined as an object example.
# First get JSON Web Token
# Retrieve your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications.
curl -v 'https://api.groupdocs.cloud/connect/token' \
-X POST \
-d "grant_type=client_credentials&client_id=$CLIENT_ID&client_secret=$CLIENT_SECRET" \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json'
# cURL example to parse a document
curl -v 'https://api.groupdocs.cloud/v1.0/parser/parse' \
-X POST \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H "Authorization: Bearer $JWT_TOKEN" \
-d '{
"Template": {
"Fields": [
{
"FieldName": "Address",
"FieldPosition": {
"FieldPositionType": "Regex",
"Regex": "Company address:"
}
},
{
"FieldName": "CompanyAddress",
"FieldPosition": {
"FieldPositionType": "Linked",
"LinkedFieldName": "ADDRESS",
"IsRightLinked": true,
"SearchArea": {
"Height": 10.0,
"Width": 100.0
},
"AutoScale": true
}
},
{
"FieldName": "Company",
"FieldPosition": {
"FieldPositionType": "Regex",
"Regex": "Company name:"
}
},
{
"FieldName": "CompanyName",
"FieldPosition": {
"FieldPositionType": "Linked",
"LinkedFieldName": "Company",
"IsRightLinked": true,
"SearchArea": {
"Height": 10.0,
"Width": 100.0
},
"AutoScale": true
}
}
],
"Tables": [
{
"TableName": "Companies",
"DetectorParameters": {
"Rectangle": {
"Position": {
"X": 77.0,
"Y": 116.0
},
"Size": {
"Height": 41.0,
"Width": 480.0
}
}
}
}
]
},
"FileInfo": {
"FilePath": "words\\docx\\companies.docx",
"StorageName": ""
}
}'
# First get JSON Web Token
# Retrieve your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications.
curl.exe -v 'https://api.groupdocs.cloud/connect/token' `
-X POST `
-d "grant_type=client_credentials&client_id=$env:CLIENT_ID&client_secret=$env:CLIENT_SECRET" `
-H 'Content-Type: application/x-www-form-urlencoded' `
-H 'Accept: application/json'
# cURL example to parse a document
curl.exe -v 'https://api.groupdocs.cloud/v1.0/parser/parse' `
-X POST `
-H 'Content-Type: application/json' `
-H 'Accept: application/json' `
-H "Authorization: Bearer $env:JWT_TOKEN" `
-d "{
'Template': {
'Fields': [
{
'FieldName': 'Address',
'FieldPosition': {
'FieldPositionType': 'Regex',
'Regex': 'Company address:'
}
},
{
'FieldName': 'CompanyAddress',
'FieldPosition': {
'FieldPositionType': 'Linked',
'LinkedFieldName': 'ADDRESS',
'IsRightLinked': true,
'SearchArea': {
'Height': 10.0,
'Width': 100.0
},
'AutoScale': true
}
},
{
'FieldName': 'Company',
'FieldPosition': {
'FieldPositionType': 'Regex',
'Regex': 'Company name:'
}
},
{
'FieldName': 'CompanyName',
'FieldPosition': {
'FieldPositionType': 'Linked',
'LinkedFieldName': 'Company',
'IsRightLinked': true,
'SearchArea': {
'Height': 10.0,
'Width': 100.0
},
'AutoScale': true
}
}
],
'Tables': [
{
'TableName': 'Companies',
'DetectorParameters': {
'Rectangle': {
'Position': {
'X': 77.0,
'Y': 116.0
},
'Size': {
'Height': 41.0,
'Width': 480.0
}
}
}
}
]
},
'FileInfo': {
'FilePath': 'words\\docx\\companies.docx',
'StorageName': ''
}
}"
:: First get JSON Web Token
:: Retrieve your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications.
curl -v "https://api.groupdocs.cloud/connect/token" ^
-X POST ^
-d "grant_type=client_credentials&client_id=%CLIENT_ID%&client_secret=%CLIENT_SECRET%" ^
-H "Content-Type: application/x-www-form-urlencoded" ^
-H "Accept: application/json"
:: cURL example to parse a document
curl -v "https://api.groupdocs.cloud/v1.0/parser/parse" ^
-X POST ^
-H "Content-Type: application/json" ^
-H "Accept: application/json" ^
-H "Authorization: Bearer %JWT_TOKEN%" ^
-d "{\"Template\":{\"Fields\":[{\"FieldName\":\"Address\",\"FieldPosition\":{\"FieldPositionType\":\"Regex\",\"Regex\":\"Company address:\"}},{\"FieldName\":\"CompanyAddress\",\"FieldPosition\":{\"FieldPositionType\":\"Linked\",\"LinkedFieldName\":\"ADDRESS\",\"IsRightLinked\":true,\"SearchArea\":{\"Height\":10.0,\"Width\":100.0},\"AutoScale\":true}},{\"FieldName\":\"Company\",\"FieldPosition\":{\"FieldPositionType\":\"Regex\",\"Regex\":\"Company name:\"}},{\"FieldName\":\"CompanyName\",\"FieldPosition\":{\"FieldPositionType\":\"Linked\",\"LinkedFieldName\":\"Company\",\"IsRightLinked\":true,\"SearchArea\":{\"Height\":10.0,\"Width\":100.0},\"AutoScale\":true}}],\"Tables\":[{\"TableName\":\"Companies\",\"DetectorParameters\":{\"Rectangle\":{\"Position\":{\"X\":77.0,\"Y\":116.0},\"Size\":{\"Height\":41.0,\"Width\":480.0}}}}]},\"FileInfo\":{\"FilePath\":\"words\\docx\\companies.docx\",\"StorageName\":\"\"}}"
{
"count": 5,
"fieldsData": [
{
"name": "ADDRESS",
"pageIndex": 0,
"pageArea": {
"rectangle": {
"position": {
"x": 85.050003051757813,
"y": 79.191001892089844
},
"size": {
"height": 13.428000450134277,
"width": 82.430992126464844
},
"coordinates": {
"top": 79.191001892089844,
"bottom": 92.619002342224121,
"left": 85.050003051757813,
"right": 167.48099517822266
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "Company address:",
"baseLine": 92.619002342224121,
"areas": []
}
}
},
{
"name": "COMPANYADDRESS",
"pageIndex": 0,
"pageArea": {
"rectangle": {
"position": {
"x": 169.96800231933594,
"y": 79.191001892089844
},
"size": {
"height": 13.428000450134277,
"width": 98.3180046081543
},
"coordinates": {
"top": 79.191001892089844,
"bottom": 92.619002342224121,
"left": 169.96800231933594,
"right": 268.28600692749023
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "address of the Aspose",
"baseLine": 92.619002342224121,
"areas": [
{
"text": "address",
"baseLine": 92.619002342224121,
"areas": []
},
{
"text": "of",
"baseLine": 92.619002342224121,
"areas": []
},
{
"text": "the",
"baseLine": 92.619002342224121,
"areas": []
},
{
"text": "Aspose",
"baseLine": 92.619002342224121,
"areas": []
}
]
}
},
"linkedField": {
"name": "ADDRESS",
"pageIndex": 0,
"pageArea": {
"rectangle": {
"position": {
"x": 85.050003051757813,
"y": 79.191001892089844
},
"size": {
"height": 13.428000450134277,
"width": 82.430992126464844
},
"coordinates": {
"top": 79.191001892089844,
"bottom": 92.619002342224121,
"left": 85.050003051757813,
"right": 167.48099517822266
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "Company address:",
"baseLine": 92.619002342224121,
"areas": []
}
}
}
},
{
"name": "COMPANY",
"pageIndex": 0,
"pageArea": {
"rectangle": {
"position": {
"x": 85.050003051757813,
"y": 56.700000762939453
},
"size": {
"height": 13.428000450134277,
"width": 72.998994827270508
},
"coordinates": {
"top": 56.700000762939453,
"bottom": 70.12800121307373,
"left": 85.050003051757813,
"right": 158.04899787902832
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "Company name:",
"baseLine": 70.12800121307373,
"areas": []
}
}
},
{
"name": "COMPANYNAME",
"pageIndex": 0,
"pageArea": {
"rectangle": {
"position": {
"x": 160.53599548339844,
"y": 56.700000762939453
},
"size": {
"height": 13.428000450134277,
"width": 32.021999359130859
},
"coordinates": {
"top": 56.700000762939453,
"bottom": 70.12800121307373,
"left": 160.53599548339844,
"right": 192.5579948425293
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "Aspose",
"baseLine": 70.12800121307373,
"areas": [
{
"text": "Aspose",
"baseLine": 70.12800121307373,
"areas": []
}
]
}
},
"linkedField": {
"name": "COMPANY",
"pageIndex": 0,
"pageArea": {
"rectangle": {
"position": {
"x": 85.050003051757813,
"y": 56.700000762939453
},
"size": {
"height": 13.428000450134277,
"width": 72.998994827270508
},
"coordinates": {
"top": 56.700000762939453,
"bottom": 70.12800121307373,
"left": 85.050003051757813,
"right": 158.04899787902832
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "Company name:",
"baseLine": 70.12800121307373,
"areas": []
}
}
}
},
{
"name": "COMPANIES",
"pageIndex": 0,
"pageArea": {
"rectangle": {
"position": {
"x": 90.699996948242188,
"y": 124.67299652099609
},
"size": {
"height": 27.356001853942871,
"width": 331.91801071166992
},
"coordinates": {
"top": 124.67299652099609,
"bottom": 152.02899837493896,
"left": 90.699996948242188,
"right": 422.61800765991211
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTableArea": {
"rowCount": 1,
"columnCount": 2,
"pageTableAreaCells": [
{
"columnIndex": 0,
"columnSpan": 1,
"pageArea": {
"rectangle": {
"position": {
"x": 90.699996948242188,
"y": 124.67299652099609
},
"size": {
"height": 27.356001853942871,
"width": 32.021999359130859
},
"coordinates": {
"top": 124.67299652099609,
"bottom": 152.02899837493896,
"left": 90.699996948242188,
"right": 122.72199630737305
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "Name\r\nAspose",
"baseLine": 152.02899837493896,
"areas": [
{
"text": "Name",
"baseLine": 138.10099697113037,
"areas": []
},
{
"text": "Aspose",
"baseLine": 152.02899837493896,
"areas": []
}
]
}
},
"rowIndex": 0,
"rowSpan": 1
},
{
"columnIndex": 1,
"columnSpan": 1,
"pageArea": {
"rectangle": {
"position": {
"x": 324.29998779296875,
"y": 124.67299652099609
},
"size": {
"height": 27.356001853942871,
"width": 98.318019866943359
},
"coordinates": {
"top": 124.67299652099609,
"bottom": 152.02899837493896,
"left": 324.29998779296875,
"right": 422.61800765991211
}
},
"page": {
"index": 0,
"size": {
"height": 841.9000244140625,
"width": 595.29998779296875
}
},
"pageTextArea": {
"text": "Address\r\naddress of the Aspose",
"baseLine": 152.02899837493896,
"areas": [
{
"text": "Address",
"baseLine": 138.10099697113037,
"areas": []
},
{
"text": "address",
"baseLine": 152.02899837493896,
"areas": []
},
{
"text": "of",
"baseLine": 152.02899837493896,
"areas": []
},
{
"text": "the",
"baseLine": 152.02899837493896,
"areas": []
},
{
"text": "Aspose",
"baseLine": 152.02899837493896,
"areas": []
}
]
}
},
"rowIndex": 0,
"rowSpan": 1
}
]
}
}
}
]
}
Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the Parser API calls and lets you use GroupDocs Cloud features in a native way for your preferred language.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
