IntellX for Sage X3 icon

IntellX for Sage X3

Read, create or modify a Sage X3 object via the XCHATX3OBJ sub-program (JSON in, JSON out)

Actions9

Describe Sage X3 Object

AI-generated

Summary

Fetches the local menus and field metadata for a Sage X3 object class by sending the DESC action to the XCHATX3OBJ sub-program. Choose the object code; optionally set a transaction or X3 context overrides and response filters.

Inputs

  • Sage X3 Object Code (required) — Object code to describe, such as ITM, SOH, or BPC.
  • Action Code — Defaults to DESC; can be edited to send a different XACTION.
  • Transaction Code — X3 transaction code. Empty uses the default.
  • Context — Optional XCHATX3OBJ overrides: language, target user, hidden fields, and response field or screen filters. The user override is honored only when the caller has GPROFIL=ADMIN.
  • Advanced Options — Can override SOAP code language, pool alias or pool ID and sub-program name; configure timeout and array reshaping; or include the raw SOAP response, parsed result, or request for debugging.

Output shape

A single output item per input item, containing a metadata record.

The record includes success, SOAP status, action, object, and ident (empty for this operation). It may also include returned data, messages, trace, sessionId, and technicalInfos. result, raw, and request are included only when enabled in Advanced Options. Single-value arrays are compacted and trailing empty array values removed by default. Errors are raised unless Continue On Fail is enabled, in which case an error record is returned.

Links

Discussion