Action Status Return Values - Official List

Hello there,

I’m currently automating software distribution within my company, and I’ve reached the stage where I need to monitor the installation process. There are additional workflows that must execute based on the outcome of installation – such as error handling, success notifications, and logging.

To do this effectively, I need a complete and official list of possible action status return values from the BigFix REST API. This is essential, as I must handle each status appropriately.

If anyone can point me to documentation or share a comprehensive list, I’d really appreciate it.

Thanks in advance for your help!

I believe the list at https://developer.bigfix.com/relevance/reference/bes-action-status.html includes all of the possible values

Look in the DB. I think this is the query I used. I also compared to API and console as all 3 can be different.

SELECT TOP (1000) [ActionState]
,[ActionStateString]
FROM [BFEnterprise].[dbo].[ACTIONSTATESTRINGS]

For example:

There shouldn’t be any discrepancies, what you’re seeing in the Console versus the API is essentially the same information presented differently. The Console shows the status but API corresponding to detailed status. If you open the specific action and view its Action Info tab in the Console, you’ll notice that the status reported via the API matches exactly with what is shown in the Console.

status of it and detailed status of it are session relevance inspectors used by the API to retrieve action state information. It’s important to identify what exactly you need.

Note: If an action is in the OPEN state, its status is still actively evaluated and can change over time as clients report in. However, once an action expires, it is no longer evaluated or updated, its status becomes static. Therefore, if you’re monitoring action statuses via API or Console, expect potential changes only while the action remains in an OPEN state.

2 Likes

The actual return values, like 3, 0, 5, etc… are the same for us.

What I was referring to is the descriptive or text name. Those can be different depending on where you are looking, between API, Console, etc. My table above shows some of those different descriptive names that represent the actual status value.