Description
This API endpoint allows the retrieval of options associated with select or multiselect attributes. The options provide additional information or categorization for the specified attribute.
Path
Specifies the target type, which can be either “collection” or “list.”
A unique identifier for the target, either a collection ID or a list ID, depending on the target type.
The ID of the select or multiselect attribute for which options are to be fetched.
Response
Indicates the success or failure of the option retrieval. In this case,
true signifies a successful operation.
Provides a human-readable message accompanying the response. In this instance,
it confirms the successful retrieval of attribute options with the message
“Attribute option list fetched successfully.”
An array containing details of the fetched attribute options. For each option
in the data array: A unique identifier for the attribute option, allowing for precise referencing.
The ID of the associated attribute to which the option belongs.
Hex color code representing the color associated with the option.
The name of the attribute option.
Indicates whether the option is archived (true/false).
The order or ranking of the option.
200-Success
401-Unauthorised
{
"status" : true ,
"message" : "Attribute option list fetched successfully" ,
"data" : [
{
"_id" : "64ad815b273e66dae1afe124" ,
"attributeId" : "64ad815b273e66dae1afe121" ,
"color" : "#dbeddb" ,
"name" : "Deliverable" ,
"isArchived" : false ,
"order" : 2
},
{
"_id" : "64ad815b273e66dae1afe125" ,
"attributeId" : "64ad815b273e66dae1afe121" ,
"color" : "#ffe2dd" ,
"name" : "Invalid" ,
"isArchived" : false ,
"order" : 3
},
{
"_id" : "64ad815b273e66dae1afe126" ,
"attributeId" : "64ad815b273e66dae1afe121" ,
"color" : "#fdecc8" ,
"name" : "Risky" ,
"isArchived" : false ,
"order" : 4
}
]
}