REST API call to retrieve the list of configured custom attributes

Execute the customAttribute/list API to access the list of configured custom attributes in ePO - On-prem.

GET Request URL

https://<epo_server_name:port>/rest/dlp/incidents/customAttribute/list

Where

epo_server_name:port is the server IP address and port number.
customAttribute/list shows the list of configured custom attributes.

Request Parameters

Use the query parameters to return the list of configured custom attributes.

Parameter name	Description	Required	Values
Authorization	User credentials for ePO - On-prem	Required

Sample GET request URL

https://172.27.108.53:8443/rest/dlp/incidents/customAttribute/list

Sample cURL command

curl -k -v -X GET 'https://ePO-url:ePO-port/rest/dlp/incidents/customAttribute/list' -u '<user>:<password>'

Response parameters

The response returns a list of custom attributes where each attribute is an object having the attribute name, its ID and the type of attribute. Returns an empty list if no custom attributes are present.

Element	Description	Data type
id	Returns the custom attribute ID	string
name	Returns the name of the custom attribute	string
type	Returns the type of custom attribute, Incident or User	string

Sample response

[
    {
        "id": "5",
        "name": "Owner"
	"type": "User"
    },
    {
        "id": "6",
        "name": "Reviewer"
	"type": "User"
    },
    {
        "id": "7",
        "name": "Modifier"
	"type": "User"	
    }
]

Status and error codes

List of HTTP status codes returned for a query.

Code	Description
200 OK	Returns the list of configured custom attributes.
404 Not Found	Incorrect ePO - On-prem URL.
500 Internal Server Error	An error on the server side that failed the request. See the ePO - On-prem `orion.log` file for more details about the error.