transform

POSTALL,EI/ChangeFormInstanceMetaData/{formInstanceId}

IN THIS PAGE

Arguments

formInstanceIdCharacter

formInstanceId of the form instance whose meta data should be changed

statusCharacter

updated form status - if blank, then the status is not changed

personCharacter

person to whom form is assigned - if blank, the person is not changed. If ^blank^, person is set to blank

duedateCharacter

due date for the form. Use yyyy-MM-dd format. If ^blank^, set to blank.

user1Character

User field

user2Character

User field

user3Character

User field

user4Character

User field

user5Character

User field

userlabel1Character

User field

userlabel2Character

User field

userlabel3Character

User field

userlabel4Character

User field

userlabel5Character

User field

Returns

resultJSON Object

Returns an object with these properties:

errorboolean

true if there was an error

errorTextstring
resultobject
rowsUpdated

number of rows in the forms table that were updated

Description

Change meta data (e.g. status, person) for an form instance specified by a formInstanceId.

CURL

CURL --insecure -H "apikey:Your_api_key" -H "content-type: application/json" -H "accept: application/json" -d "{"""status""":value_of_status,"""person""":value_of_person,"""duedate""":value_of_duedate,"""user1""":value_of_user1,"""user2""":value_of_user2,"""user3""":value_of_user3,"""user4""":value_of_user4,"""user5""":value_of_user5,"""userlabel1""":value_of_userlabel1,"""userlabel2""":value_of_userlabel2,"""userlabel3""":value_of_userlabel3,"""userlabel4""":value_of_userlabel4,"""userlabel5""":value_of_userlabel5}" "https://transform.alphasoftware.com/transformAPIVersion1.a5svc/ChangeFormInstanceMetaData/value_of_formInstanceId"

Node

var request = require('request')
var path = 'https://transform.alphasoftware.com/transformAPIVersion1.a5svc/ChangeFormInstanceMetaData/value_of_formInstanceId';
var data = {"status": "value_of_status","person": "value_of_person","duedate": "value_of_duedate","user1": "value_of_user1","user2": "value_of_user2","user3": "value_of_user3","user4": "value_of_user4","user5": "value_of_user5","userlabel1": "value_of_userlabel1","userlabel2": "value_of_userlabel2","userlabel3": "value_of_userlabel3","userlabel4": "value_of_userlabel4","userlabel5": "value_of_userlabel5"};
var dataJSON = JSON.stringify(data)
request.post(
	{
		headers: {apikey: "Your_api_key"},   
		url: path, 
		form: dataJSON}, 
		function(err,httpResponse,body){
			if(err) console.log(err)
			console.log(body)
	}
)

Xbasic

dim apikey as c = "Your_api_key"
dim postdata as c
postdata = <<%txt%
{
    "status": "value_of_status",
    "person": "value_of_person",
    "duedate": "value_of_duedate",
    "user1": "value_of_user1",
    "user2": "value_of_user2",
    "user3": "value_of_user3",
    "user4": "value_of_user4",
    "user5": "value_of_user5",
    "userlabel1": "value_of_userlabel1",
    "userlabel2": "value_of_userlabel2",
    "userlabel3": "value_of_userlabel3",
    "userlabel4": "value_of_userlabel4",
    "userlabel5": "value_of_userlabel5"
}

%txt%

dim url as c = "/ChangeFormInstanceMetaData/value_of_formInstanceId"
dim pr as p
pr = a5dialogHelper_transformAPIQuery(url,postdata,apikey)
if pr.error = .f. then
	dim result as c 
	result = pr.result
else
	dim errorText as c 
	errorText = pr.errorText
end if