Retrieve an opcode

Updated:

GET/dms/{connection_id}/opcode/{id}

Retrieves a single DmsOpcode by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Opcode

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
codestringNoOperation code
descriptionstringNo
typeenumNoValues: LABOR, MENU, SUBLET, OTHER
categorystringNoOperation category or group
pay_typeenumNoDefault pay type Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
flat_rate_hoursnumberNoBillable (flat-rate) hours
estimated_hoursnumberNoExpected duration, for scheduling
currencystringNoISO 4217 currency code
price_amountnumberNoFixed selling price
labor_rate_amountnumberNoDefault hourly labor rate
skill_codestringNoRequired technician skill or skill level
makestringNoVehicle make the operation applies to
oem_codestringNoManufacturer labor operation code
is_activebooleanNo
partsDmsPartline[]NoParts included in the operation
parts[].idstringNoLine identifier
parts[].part_idstringNoThe DmsPart ID
parts[].part_numberstringNoPart number as sold
parts[].manufacturer_codestringNoMake, brand or line code the part number belongs to
parts[].descriptionstringNo
parts[].pay_typeenumNoWho pays for this line Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE_CONTRACT, OTHER
parts[].quantitynumberNoQuantity sold or issued
parts[].quantity_orderednumberNoQuantity requested by the customer
parts[].unit_price_amountnumberNoUnit selling price
parts[].list_price_amountnumberNoUnit list or retail price
parts[].unit_cost_amountnumberNoUnit dealer cost
parts[].total_amountnumberNoExtended selling amount
parts[].total_cost_amountnumberNoExtended dealer cost
parts[].tax_amountnumberNo
metadataDmsMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/opcode/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?