ProcFields

ProcFields(
    int ProcessID
)

Get process fields information

Request

Request Data:

  • (int) ProcessID (required) – Identify the ID of the process.
{
	"ProcessID": <int>
}

Response

{
    "Result": {
        "Process": {
            "FieldGroups": [
                {
                    "Name": <string>,
                    "ID": <int>,
                    "Effect":  <enum 1:"Hide", 2:"Unlock", 3:"Lock", 4:"Show">,
                    "Type": <enum 522: "Reference", 500: "Custom Field", 511: "Form Status">,
                    "FieldType": <int>,
                    "SpecificID": <int>,
                    // Value1 and Value2 indicate the range of values that the FG is made 'active'
                    // If any of them is an empty string, then the comparison is greater than or less than 
                    // All comparisons are excluding the values (greater than, less than)
                    "Value1": <string>,
                    "Value2": <string>,
                },
                ... more field groups
            ],
            "Fields": [
                {
                    "FormatType": <int>,
                    "InternalFormat": {
                        "Instruction": <string>,
                        "Pattern": <string>, // (For Text fields) Input mask for text fields
                        "PatternEnabled": <bool>, // (For Text fields) Whether the field should enforce the pattern (Ignore CharacterLimit if true)
                    },
                    "IsRepeating": <boolean>,
                    "IsRequiredForUser": <boolean>,
                    "LayoutFormat": {
                        "Order": <int>,
                        "Width": <int>
                    },
                    "Name": <string>,
                    "SubType": <int>,
                    "Tuid": <string>,
                    "UserCanEdit": <boolean>,
                    "CharacterLimit": <int>, // (For Text fields, Since: RPM16) - See also InternalFormat.PatternEnabled
                },
                ... more fields
            ],
            "Folders": [ // Available since RPM15
                {
                  "Name": <string>,
                  "ID": <int>,
                  "AllowMulti": <bool>,
                  "Order": <int>,
                  "Instruction": <string>,
                  "Required": <bool>
                },
                ... more folders
            ],
            "StatusLevels": [
                {
                  "Text": <string>,
                  "ID": <int>,
                  "Order": <int>,
                  "ShowSignature": <bool>,
                },
                ... more status levels
            ],
            "ProcessID": <int>
        },
        // Measurement fields in RPM use Metric units by default.
        // If the value of the field with FieldUID matches any of the values
        // listed values in "Values" then switch to non-metric units
        "MeasurementFieldControl": {
          "FieldUID": <string>, 
          "Values": <string>
        }
    }
}

Errors

  • “Process not found”
%d bloggers like this: