CustomField

Returns a list of all custom fields and their details.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Responses
200

Success

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

get/api/v1/customField
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Create a new custom field.
All fields are required. EntityGUID refers to the ID associated with the item the custom field record is being attached to (e.g. Equipment ID, Parts ID, Work Request ID, etc.)
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
Request Body schema: 
required
customFieldCategoryId
required
integer <int32> 
The custom field category ID the custom field record is being created for.


 
entityGuid
required
string <uuid> 
The ID of the target the custom field record is being created for.


 
value
required
string
The value being assigned to the custom field record.


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/customField
Request samples 
{
  • "customFieldCategoryId": 6,
  • "entityGUID": "f8f39d3a-4778-4040-a770-dbd573db7d00",
  • "value": "My Division"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "customFieldType": "string",
  • "customFieldName": "string",
  • "customFieldCategoryId": 0,
  • "entityId": 0,
  • "entityGuid": "650beb56-442d-455d-ad73-5af53b580484",
  • "value": "string"
}