Description
This API endpoint allows the retrieval of options associated with status attributes. Status attributes are used to define different stages or states that an item can go through in a collection or list.
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 status attribute for which options are to be fetched.
Response
Indicates the success or failure of the status 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 status options with the message
“Attribute status list fetched successfully.”
An array containing details of the fetched attribute status options. For each option
in the data array: A unique identifier for the attribute status option, allowing for precise referencing.
The ID of the associated status attribute to which the option belongs.
The name of the attribute status option.
Hex color code representing the color associated with the status option.
Indicates whether the status option is archived (true/false).
The time, in seconds, that items spend in this status option.
Indicates whether celebration is enabled for this status option (true/false).
Specifies the type of status. It can be “normal” or other applicable types.
The order or ranking of the status option.
200-Success
401-Unauthorised
{
"status" : true ,
"message" : "Attribute status list fetched successfully" ,
"data" : [
{
"_id" : "64ae57b3a3325d9749556eee" ,
"attributeId" : "64ae57b3a3325d9749556eeb" ,
"name" : "Stage 1" ,
"color" : "#e57b00" ,
"isArchived" : false ,
"timeInStatus" : 0 ,
"celebrationEnabled" : false ,
"statusType" : "normal" ,
"__v" : 0 ,
"order" : 1
},
{
"_id" : "6520b88e4f7b6dea01cf9b7b" ,
"attributeId" : "64ae57b3a3325d9749556eeb" ,
"name" : "Stage 2" ,
"color" : "#02b55c" ,
"order" : 2 ,
"isArchived" : false ,
"timeInStatus" : null ,
"celebrationEnabled" : false ,
"statusType" : "normal" ,
"__v" : 0
}
]
}