AvantGuard - Sage Intacct (Common Services) icon

AvantGuard - Sage Intacct (Common Services)

AvantGuard - Sage Intacct (Common Services)
Join our community

Actions6

Overview

This node interacts with the "Models" resource of an API to retrieve service models. Specifically, the "Get Services Model" operation fetches metadata about available services or resources from the API, including detailed schema information if requested. This is useful for dynamically exploring or integrating with the API by understanding the structure and types of resources it exposes.

Common scenarios include:

  • Discovering available services or objects in the API before performing further operations.
  • Retrieving detailed schema definitions to validate or construct requests dynamically.
  • Fetching version-specific resource models to handle API changes gracefully.

For example, a user might use this node to get the model definition of a vendor resource (accounts-payable/vendor) to understand its fields and data types before creating or updating vendor records.

Properties

Name Meaning
Additional Query Parameters Optional query parameters to customize the request:
- Name: The resource name in the format <application-name>/<resource name>. Some services have 3-part names (e.g., company-config/document-sequence/get-next-sequence). For custom objects use platform-apps/nsp::<object-name>.
- Type: The type of resource to list or get, such as object, service, workflow, or specific types like ownedObject. Can be a comma-separated list excluding object and service.
- Version: API version to target (default v1). Use version=ALL to get all versions.
- Schema: Whether to return the full model (true) or a short definition (false). Defaults to true when requesting a single resource, otherwise false.
- Tags: Whether to return the schema with wrapping objects for groups, refs, and lists (true) or without them (false). Default is false.

Output

The node outputs JSON data representing the requested service model(s). The structure depends on the query parameters:

  • When requesting a single resource model with schema=true, the output includes the full detailed schema describing fields, types, and nested structures.
  • When requesting a list of resources or with schema=false, the output contains summarized definitions or lists of resource names and types.
  • If multiple versions are requested (version=ALL), the output includes version metadata.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authentication to the target API.
  • The base URL for the API must be configured in the node credentials.
  • Depends on the external API endpoint /ia/api/v1/model or similar to fetch resource models.
  • Uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Invalid Resource Name: If the name parameter is incorrect or malformed, the API may return a 404 or error indicating the resource was not found. Verify the exact resource naming convention.
  • Unsupported Version: Specifying a non-existent API version may cause errors or empty results. Confirm available versions via version=ALL.
  • Authentication Errors: Missing or invalid API credentials will result in authorization failures. Ensure the API key credential is correctly set up.
  • Schema Parameter Issues: Setting schema incorrectly may lead to incomplete or overly verbose responses. Adjust based on whether you want full schema details or summaries.
  • Network or Connectivity Problems: Check network access to the API base URL and that no firewall or proxy blocks the requests.

Links and References

Discussion