Plunet icon

Plunet

Get and Set Data for Plunet BusinessManager

Actions156

Job Fields → Get Description

AI-generated

Summary

Retrieve the description of a job's fields (e.g., custom fields) from Plunet for a given job ID and project type.

Inputs

  • jobID (required) — The numeric ID of the job whose description should be fetched. Must be greater than 0 for a valid request; the default value of 0 will result in an error or empty response if used unchanged.
  • projectType — Indicates whether the job is a Quote or an Order. Determines which set of fields is returned. Options are 'Quote' (value 1) or 'Order' (value 3). Defaults to 'Order' (3).

Output shape

An object containing the job description returned by the Plunet API (e.g., field definitions, labels, data types). The exact structure mirrors the JSON payload of the Plunet getDescription endpoint for the specified resource.

The operation is read‑only; it does not modify any data in Plunet.

Examples

Example 1: Get the field description for order job #12345

jobID: 12345, projectType: Order (3)

Discussion