Example of Using the Rest Api to Create an Entry on a Form - Documentation for Ar System 21.05

This example provides information to get multiple entries in a Simple form.

Request URL

GET 

Request headers

Authorization: AR-JWT eyJhbGciOiJIUzI1NiJ9.
eyJleHAiOjE0MTc2NTM1ODgsInN1YiI6IkFsbGVuIiwibm
JmIjoxNDE3NjQ5ODY4LCJpc3MiOiJXLUNTRUlFUk9FLTI5Lm
FkcHJvZC5ibWMuY29tIiwianRpIjoiSURHQUFCRFVDMllHSUFONkJGUTJBQUFFUEZBNVFXIiwiX
2NhY2hlSWQiOjQ3LCJpYXQiOjE0MTc2NDk5ODh9.V4LGLcEdwD8V_I4rzoWYYSZmEMA82LBB_lEfz4Xnz9Y

This example provides information about the Rest API request parameters to get multiple entries. 

Request URL

 host:8008/api/arsys/v2.0/entry/SampleForm/?q=('Status'="Assigned")&sort=Real
Number Field.asc&offset=1&limit=2&fields=values(Request ID,Real
Number Field)

Request headers

Authorization: AR-JWT eyJhbGciOiJIUzI1NiJ9.
eyJleHAiOjE0MTc2NTM1ODgsInN1YiI6IkFsbGVuIiwibm
JmIjoxNDE3NjQ5ODY4LCJpc3MiOiJXLUNTRUlFUk9FLTI5Lm
FkcHJvZC5ibWMuY29tIiwianRpIjoiSURHQUFCRFVDMllHSUFONkJGUTJBQUFFUEZBNVFXIiwiX
2NhY2hlSWQiOjQ3LCJpYXQiOjE0MTc2NDk5ODh9.V4LGLcEdwD8V_I4rzoWYYSZmEMA82LBB_lEfz4Xnz9Y

Response body

[{
    "values": {
        "Request ID": "000000000000004",
        "Real Number Field": 3245.215566
    },
    "_links": {
        "self": [{
            "href": " host:8008/api/arsys/v1/entry/QueryParamTest/000000000000004"
        }]
    }
}, {
    "values": {
        "Request ID": "000000000000001",
        "Real Number Field": 223232.213266
    },
    "_links": {
        "self": [{
            "href": " host:8008/api/arsys/v1/entry/QueryParamTest/000000000000001"
        }]
    }
}]

Following is a sample code snippet for the POST operation for multiple entries.

package com.example;

import java.nio.charset.StandardCharsets;

import org.apache.http.HttpEntity;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class GetMultiple {

    public static void main(String[] args) throws Exception {
        String token = args[0];

        // start HTTP GET to get an entry
        CloseableHttpClient httpClient = HttpClients.createDefault();
        HttpGet httpGet = new HttpGet("");

        // add the token to the header
        httpGet.addHeader("Authorization", "AR-JWT " + token);

        // make the call and print the status
        try (CloseableHttpResponse response = httpClient.execute(httpGet)) {
            HttpEntity entity = response.getEntity();
            String jsonEntry = EntityUtils.toString(entity, StandardCharsets.UTF_8);
            System.out.println(jsonEntry);
        }
    }

}

This example provides information to create an entry with an attachment in a Simple form.

Request URL

 host:8008/api/arsys/v2.0/entry/SampleForm/?q=('Status'="Assigned")&sort=Real
Number Field.asc&offset=1&limit=2&fields=values(Request ID,Real
Number Field)

Request headers

Authorization: AR-JWT eyJhbGciOiJIUzI1NiJ9.
eyJzdWIiOiJxSmNGRjgwY0JOeTgyUDRkUm1vTz
RHZ1dKQ1QrZ3pzYUpybVwvMFRwMktMYkJXeUd4ZWt1VG1VMW1r
NXkzcE9aRk9NRlhVM1JTZ3BDbjRNUmR4MVRQRnpGQ2hpNE5KaGk3ZUxCNVlFOFFz
VVJuYm1HbklHaVc0UT09IiwibmJmIjoxNDQ3NzkzMjQ5LCJfaW1wZXJzb25hdGVkVXNl
ciI6bnVsbCwiaXNzIjoiVy1DU0VJRVJPRS0yOS5hZHByb2QuYm1jLmNvbSIsIl9jYWNoZUlkIjox
NDAsImV4cCI6MTQ0Nzc5Njk2OSwiaWF0IjoxNDQ3NzkzMzY5LCJqdGkiOiJJREdBQUJEVUMyWU
dJQU5YWkk4N0FBQkJPV0RORTkifQ.S4PqNJ_LNLqHxfbI6nn7lJA_aI4_-qDVx4hqR3TfprQ

Content-Length: 17553
Content-Type: multipart/form-data;boundary=W3NByNRZZYy4ALu6xeZzvWXU3NVmYUxoRB

Request body

--W3NByNRZZYy4ALu6xeZzvWXU3NVmYUxoRB
Content-Disposition: form-data; name="entry"
Content-Type: application/json; charset=UTF-8
Content-Transfer-Encoding: 8bit

{ 
	"values" : 
		{ "Submitter" :"Allen", "Short Description" : "testing 123", "Attachment1" : "sample.jpg"
		} 
}

--W3NByNRZZYy4ALu6xeZzvWXU3NVmYUxoRB
Content-Disposition: form-data;
name="attach-Attachment1"; filename="sample.png"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary

<binary data removed for brevity>
--W3NByNRZZYy4ALu6xeZzvWXU3NVmYUxoRB--

Response body

HTTP/1.1 200 OK
Date: Wed, 03 Dec 2014 22:53:46 GMT
Content-Type: application/json
Server: Jetty(8.1.15.v20140411)
{
"entries": [
	{
      "values":
		{
         "Request ID":"000000000000103","Submitter":"Allen",
         "Create Date":"2014-12-03T22:53:37.000+0000",
         "Assigned To":null,
         "Last Modified By":"chris",
         "Modified Date":"2014-12-03T22:53:37.000+0000",
         "Status":"New",
         "Short Description":"testing 123",
         "Status History":{
				"New":{
					"user":"chris",
					"timestamp":"2014-12-03T22:53:37.000+0000"
					  }
					}
		},
	"_links":{
		"self":[
			{"href":""
            }
          ]
	    }
    }
  ],
  "_links":{
		"self":[
	            {"href":""
                }
              ]
          }
}

This example provides information to retrieve records from record 200 to record 400 in a form.

Request URL

 host:8008/api/arsys/v2.0/entry/SampleForm?offset=200&limit=200 

Request headers

Authorization: AR-JWT eyJhbGciOiJIUzI1NiJ9.
eyJleHAiOjE0MTc2NTM1ODgsInN1YiI6IkFsbGVuIiwibm
JmIjoxNDE3NjQ5ODY4LCJpc3MiOiJXLUNTRUlFUk9FLTI5Lm
FkcHJvZC5ibWMuY29tIiwianRpIjoiSURHQUFCRFVDMllHSUFONkJGUTJBQUFFUEZBNVFXIiwiX
2NhY2hlSWQiOjQ3LCJpYXQiOjE0MTc2NDk5ODh9.V4LGLcEdwD8V_I4rzoWYYSZmEMA82LBB_lEfz4Xnz9Y

Response body

{
    "entries": [
        {
            "values": {
                "Request ID": "000000000000201",
                "Character Field1": null,
                "Submitter": "SG1U4",
                "Character Field2": null,
                "Create Date": "2017-01-13T08:49:49.000+0000",
                "Status History": {
                    "New": {
                        "user": "Demo",
                        "timestamp": "2017-01-13T08:49:49.000+0000"
                    }
                },
                "Character Field14": null,
                "Notifier Listening": "Not Listening",
                "Character Field15": null,
                "112": "30000;30001;30002;30003;30004;30005;30006;30007;30008;30009;30010;30011;30012;30013;30014;30015;30016;30017;30018;30019;30020;30021;30022;30023;30024;30025;30026;30027;30028;30029;30030;30031;30032;30033;30034;30035;30036;30037;30038;30039;30040;30041;30042;30043;30044;30045;30046;30047;30048;30049;",
                "Record ID": "AGGIZW4ECUGASAQPD9ZIQPD9ZI02O8"
            },
            "_links": {
                "self": [
                    {
                        "href": ""
                    }
                ]
            }
        },
        {
            "values": {
                "Request ID": "000000000000202",
                "Character Field1": null,
                "Submitter": "SG1U4",
                "Status History": {
                    "New": {
                        "user": "Demo",
                        "timestamp": "2017-01-13T08:49:49.000+0000"
                    }
                },
                "Character Field14": null,
                "Notifier Listening": "Not Listening",
                "Character Field15": null,
                "112": "30000;30001;30002;30003;30004;30005;30006;30007;30008;30009;30010;30011;30012;30013;30014;30015;30016;30017;30018;30019;30020;30021;30022;30023;30024;30025;30026;30027;30028;30029;30030;30031;30032;30033;30034;30035;30036;30037;30038;30039;30040;30041;30042;30043;30044;30045;30046;30047;30048;30049;",
                "Record ID": "AGGIZW4ECUGASAQPD9ZIQPD9ZI02O9"
            },


                "Record ID": "AGGIZW4ECUGASAQPD9ZIQPD9ZI02UB"
            },
            "_links": {
                "self": [
                    {
                        "href": ""
                    }
                ]
            }
        },
…
…
…
        {
            "values": {
                "Request ID": "000000000000400",
                "Character Field1": null,
                "Submitter": "SG1U8",
                "Status History": {
                    "New": {
                        "user": "Demo",
                        "timestamp": "2017-01-13T08:49:50.000+0000"
                    }
                },
                "Character Field14": null,
                "Notifier Listening": "Not Listening",
                "Character Field15": null,
                "112": "30000;30001;30002;30003;30004;30005;30006;30007;30008;30009;30010;30011;30012;30013;30014;30015;30016;30017;30018;30019;30020;30021;30022;30023;30024;30025;30026;30027;30028;30029;30030;30031;30032;30033;30034;30035;30036;30037;30038;30039;30040;30041;30042;30043;30044;30045;30046;30047;30048;30049;",
                "Record ID": "AGGIZW4ECUGASAQPD9ZIQPD9ZI02UC"
            },
            "_links": {
                "self": [
                    {
                        "href": ""
                    }
                ]
            }
        }
    ],
    "_links": {
        "next": [
            {
                "href": ""
            }
        ],
        "prev": [
            {
                "href": ""
            }
        ],
        "self": [
            {
                "href": ""
            }
        ]
    }
}