Retry Push API

Endpoint Name: URL/access/klearstack/retry_push_api

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The retry_push_api endpoint will be used to update enable / disable fields or update the settings of fields.

Method	URL
POST	URL/klearstack/retry_push_api

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in
username	string	Yes	User Name
collection_name	string	Yes	Document Type
data		Yes	[{ "documentTypeDetails": { "invoices": { "fields": { "doc_number_value": { "label": "Invoice Number", "required": true, "visibility": true } } } } }]

Shell (cURL)

• Request Body

curl --location 'URL/klearstack/retry_push_api' \
--header 'Authorization: Bearer your_token_here' \
--form 'company_name="Replace_Company_Name_Here"' \
--form 'username="Replace_Username_Here"' \
--form 'collection_name="Replace_Collection_Name_Here"' \
--form 'data="[{
    \"documentTypeDetails\": {
      \"invoices\": {
        \"fields\": {
          \"doc_number_value\": {
            \"label\": \"Invoice Number\",
            \"required\": true,
            \"visibility\": true
          }
        }
      }
    }
  }]"'

Python

• Request Body

import requests

url = "URL/klearstack/retry_push_api"

payload = {'company_name': 'Replace_Company_Name_Here',
'username': 'Replace_Username_Here',
'collection_name': 'Replace_Collection_Name_Here',
'data': '[{
    "documentTypeDetails": {
      "invoices": {
        "fields": {
          "doc_number_value": {
            "label": "Invoice Number",
            "required": true,
            "visibility": true
          }
        }
      }
    }
  }]'}
files=[

]
headers = {
  'Authorization': 'Bearer your_token_here'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Java (OkHttp)

• Request Body

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("company_name", "Replace_Your_Company_Name_Here")
  .addFormDataPart("username", "Replace_Your_Username_Here")
  .addFormDataPart("collection_name", "Replace_Your_Collection_Name_Here")
  .addFormDataPart("data", "[{\n" +
    "  \"documentTypeDetails\": {\n" +
    "    \"invoices\": {\n" +
    "      \"fields\": {\n" +
    "        \"doc_number_value\": {\n" +
    "          \"label\": \"Invoice Number\",\n" +
    "          \"required\": true,\n" +
    "          \"visibility\": true\n" +
    "        }\n" +
    "      }\n" +
    "    }\n" +
    "  }\n" +
    "}]")
  .build();
Request request = new Request.Builder()
  .url("URL/klearstack/retry_push_api")
  .method("POST", body)
  .addHeader("Authorization", "Bearer Replace_Your_Token_Here")
  .build();
Response response = client.newCall(request).execute();

Node.js (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');

let formData = new FormData();
formData.append('company_name', 'Replace_Your_Company_Name_Here');
formData.append('username', 'Replace_Your_Username_Here');
formData.append('collection_name', 'Replace_Your_Collection_Name_Here');
formData.append('data', '[{\r\n    "documentTypeDetails": {\r\n      "invoices": {\r\n        "fields": {\r\n          "doc_number_value": {\r\n            "label": "Invoice Number",\r\n            "required": true,\r\n            "visibility": true\r\n          }\r\n        }\r\n      }\r\n    }\r\n  }]');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/klearstack/retry_push_api',
  headers: { 
    'Authorization': 'Bearer Replace_Your_Token_Here', 
    ...formData.getHeaders()
  },
  data: formData
};

axios.request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

JavaScript (XHR)

• Request Body

// WARNING: For POST requests, body is set to null by browsers.

var formData = new FormData();
formData.append("company_name", "Replace_Your_Company_Name_Here");
formData.append("username", "Replace_Your_Username_Here");
formData.append("collection_name", "Replace_Your_Collection_Name_Here");
formData.append("data", "[{\r\n    \"documentTypeDetails\": {\r\n      \"invoices\": {\r\n        \"fields\": {\r\n          \"doc_number_value\": {\r\n            \"label\": \"Invoice Number\",\r\n            \"required\": true,\r\n            \"visibility\": true\r\n          }\r\n        }\r\n      }\r\n    }\r\n  }]");

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "URL/klearstack/retry_push_api");
xhr.setRequestHeader("Authorization", "Bearer Replace_Your_Token_Here");

xhr.send(formData);

API Response

Status code	Example Response
200	Request Submitted Successfully