Retrieve one maintenance description

When to use this endpoint

Use AssetMaintenance_getDescriptions only when a single recurrence ID must be translated to its legacy maintenance label. The CRM1 Jobs list uses the plural batch endpoint instead.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session. The handler performs no additional page or role-permission check.

The lookup and any write use the authenticated tenant; an ID from another tenant cannot be addressed through this call.

Parameters

Parameter	Type	Required	Description
`rid`	Integer string	Yes	Positive recurrence ID, not the maintenance ID.

Example request

$description = FM_api('AssetMaintenance_getDescriptions', [
	'rid' => '879027',
]);

Example response

{
  "name": "Filter service"
}

A missing recurrence match returns JSON false, not an empty object or an error.

Errors and unusual responses

Response	Condition
`{"error":"not logged in"}`	No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
`{"error":"missing or invalid parameter: rid"}`	`rid` is absent or not positive.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

Only the description is selected. If corrupt data contains multiple maintenance rows for the same recurrence, the database helper returns one without a defined order.
There is no active-state, asset-state, or feature filter.

See it in Fieldmotion

CRM1

No direct production CRM1 caller was found; the Jobs list uses AssetMaintenances_getDescriptions to batch these lookups.

CRM2

No production CRM2 caller was found.

Related endpoints

AssetMaintenances_getDescriptions resolves several recurrence IDs in one query.
AssetMaintenance_listNames lists all distinct descriptions rather than resolving by recurrence.