API explorer
Fleet Management API Beta

Sections

Theme switcher

Get a UDF field by ID.

Authentication

Bearer Token

Standard HTTP Bearer token. Enter the 'access_token' value.

TokenstringRequired

Header Parameters

Authorizationstring

This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.

Access Tokens have a lifespan of 15 minutes.

Requesting an access token

Parameters:

  • client_id = my-client-id
  • client_secret = my-client-secret
  • [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...

Path Parameters

udf-field-idinteger Required

Response

200
Object

200 (Ok)

Response Attributes

date_modifiedstring
editable_on_transactionboolean

Is this field editable on a transaction.

has_codesboolean

Does this field have codes.

max_lengthinteger

The maximum length for the field.

min_lengthinteger

The minimum length for the field.

namestring

The name for this field.

Max length
30
object_typestring

The type of accounting object.

Enum values:
ACCOUNTPDDRIVERASSET
requiredboolean

Is this field required.

statusstring

Whether and entity is Active or Inactive. Defaults to Active on create operations.

Enum values:
ACTIVEINACTIVE
udf_codesarray

Codes associated to this field.

Max items
5000

Show child attributes

udf_field_idinteger

The unique id for a UDF Field.

udf_indexstring

The "UDF" index assigned to this field. Can be UDF1....UDF20.

400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

403 (Forbidden)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

404 (Not Found)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?