Create custom reports with Survey123 featureReport API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// Replace with your actual values
const featureLayerUrl = "https://services.arcgis.com/your_org/arcgis/rest/services/your_survey/FeatureServer/0";
const token = "YOUR_ACCESS_TOKEN";

// Prepare the form data
const formData = new FormData();
formData.append("featureLayerUrl", featureLayerUrl);
formData.append("token", token);
formData.append("outputFormat", "docx"); // or 'pdf'

// POST request to create sample template
fetch("https://survey123.arcgis.com/api/featureReport/createSampleTemplate", {
  method: "POST",
  body: formData
})
.then(response => {
  if (!response.ok) throw new Error("Network response was not ok");
  return response.blob();
})
.then(blob => {
  // Download the template file
  const url = window.URL.createObjectURL(blob);
  const a = document.createElement("a");
  a.style.display = "none";
  a.href = url;
  a.download = "Survey123_Sample_Template.docx";
  document.body.appendChild(a);
  a.click();
  window.URL.revokeObjectURL(url);
})
.catch(error => {
  console.error("Error creating template:", error);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
// Replace with your actual values
const featureLayerUrl = "https://services.arcgis.com/your_org/arcgis/rest/services/your_survey/FeatureServer/0";
const token = "YOUR_ACCESS_TOKEN";

// Get template file from file input
const fileInput = document.getElementById("templateFileInput");

fileInput.addEventListener("change", function(event) {
  const file = event.target.files[0];
  if (!file) {
    alert("Please select a template file (.docx).");
    return;
  }

  // Prepare form data
  const formData = new FormData();
  formData.append("templateFile", file);
  formData.append("featureLayerUrl", featureLayerUrl);
  formData.append("token", token);

  // POST request to validate template
  fetch("https://survey123.arcgis.com/api/featureReport/checkTemplateSyntax", {
    method: "POST",
    body: formData
  })
  .then(response => response.json())
  .then(result => {
    if (result.error) {
      console.error("Error:", result.error);
    } else if (result.syntaxErrors && result.syntaxErrors.length > 0) {
      console.error("Syntax errors:", result.syntaxErrors);
    } else {
      console.log("Template is valid");
    }
  })
  .catch(error => {
    console.error("Error checking template:", error);
  });
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
// Replace with your actual values
const featureLayerUrl = "https://services.arcgis.com/your_org/arcgis/rest/services/your_survey/FeatureServer/0";
const templateItemId = "YOUR_TEMPLATE_ITEM_ID";
const token = "YOUR_ACCESS_TOKEN";

// Build request payload
const payload = {
  featureLayerUrl,
  templateItemId,
  token,
  queryParameters: {
    objectIds: "1,2,3" // Generate reports for specific records
  },
  outputFormat: "pdf",
  outputReportName: "My_Report",
  packageFiles: true
};

// Submit report generation job
fetch("https://survey123.arcgis.com/api/featureReport/createReport", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify(payload)
})
.then(response => response.json())
.then(result => {
  if (result.jobId) {
    console.log("Job submitted:", result.jobId);
    // Poll job status (see next example)
  } else if (result.error) {
    console.error("Error:", result.error.message);
  }
})
.catch(error => {
  console.error("Error submitting job:", error);
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
// Replace with your actual token
const token = "YOUR_ACCESS_TOKEN";

// Poll job status
function checkJobStatus(jobId) {
  fetch(`https://survey123.arcgis.com/api/featureReport/jobs/${jobId}?token=${token}`)
  .then(response => {
    if (!response.ok) throw new Error("Network response was not ok");
    return response.json();
  })
  .then(result => {
    console.log("Job status:", result.jobStatus);

    if (result.jobStatus === "esriJobSucceeded") {
      // Download completed reports
      result.resultFiles.forEach(file => {
        console.log("Download:", file.url);
        // Handle file download
        window.open(file.url, "_blank");
      });
    } else if (result.jobStatus === "esriJobFailed") {
      console.error("Job failed:", result.messages);
    } else if (result.jobStatus === "esriJobExecuting" || result.jobStatus === "esriJobSubmitted") {
      // Job still running, poll again after 5 seconds
      setTimeout(() => checkJobStatus(jobId), 5000);
    }
  })
  .catch(error => {
    console.error("Error checking job status:", error);
  });
}

// Start polling with job ID from report generation
checkJobStatus("your_job_id");