Api/ProcFormWorksheetAdd

From RPM Wiki

Table of contents

Summary

API: Add a worksheet to a form by copying an existing worksheet.

Request

You need to identify the form and worksheet.

By form ID and worksheet ID.

{
  "Key":"{api key}",
  "FormID":"{form id}",
  "WorksheetID":"{worksheet id}"
}

Example

http://demo.rpmsoftware.com/rpm/Api.svc/ProcFormWorksheetAdd

{
  "Key":"abc123def456",
  "FormID":"11232",
  "WorksheetID":"3320"
}

Response

Use the response from Api/ProcFormWorksheet

Details

  • A worksheet is eligible if it belongs to the template in the same process ("Add a worksheet" in the UI) or a form in the same process ("Copy" worksheet in the UI).
  • If the worksheet is being copied from a different form then you need to make sure the user also has read access to that form.
  • If the worksheet is being added from a template worksheet then add any tables that are included by default, just like if the worksheet was added using the UI.

Errors

  • "Form not found"
  • "Permission denied" (if the user isn't allowed to add a worksheet to that form)
  • "Worksheet not found"
  • "Worksheet is wrong process"
  • "Worksheet is not enabled"

History

  • This page was last modified 17:12, 11 Feb 2010.
  • This page has been accessed 631 times.