How to trigger SC Task UI Action via the Rest API?

[ykara]

Hi I need to update the state field for our SC Tasks via the REST API but the field is protected I assume by a workflow and can only be updated by the UI Action buttons "In Progress", "Close Task" and "Cancel".

How can I trigger these UI Actions for specific SC Task numbers via the API?

I've asked various AI bots and some say you cant do it, some say can but then have hallucinated false ways of doing so

[Bhuvan]

@ykara 

Try this,

https://www.servicenow.com/community/developer-forum/ui-action-to-trigger-rest-api-post-call/m-p/272...

If this helped to answer your query, please mark it helpful & accept the solution. 

Thanks,

Bhuvan

[Ankur Bawiskar]

@ykara 

It should allow update but if field is marked Readonly at dictionary then it won't allow.

Also check if any data policy is blocking that field update.

If my response helped please mark it correct and close the thread so that it benefits future readers.

[ykara]

Hi Ankur

I have asked our client if the read-only can be removed from the state field but not expecting a quick answer from them.

However, I was hoping there was a way to trigger those buttons or the workflow behind them using the API. There was hint in this post on doing this but the poster wanted to do it on the table level rather than the record level. I am looking to do it on the record (SC Task) level but not exactly sure how to make the API call.

[Ravi Gaurav]

Hi @ykara 

Note : The below suggestion given by Product Documentation ServiceNow.. Summarized by AI

You essentially have three options:

1. Call the same business logic that the UI Action calls

• Each of those buttons (In Progress, Close Task, Cancel) is backed by either:

  • A UI Action script, or

  • A Flow/Business Rule triggered by the UI Action.

• Inspect the UI Action record for sc_task (System UI > UI Actions).

• You’ll see a script that might be calling task.setWorkflow(...), updating state, and running extra logic (notifications, approvals, etc.).

• You can refactor that script into a Script Include (API-safe), then call it via REST (using GlideAjax or a custom scripted REST API).

This is the most maintainable approach.

 

2. Expose a Scripted REST API wrapper

• Create a Scripted REST API called, for example, TaskStateAPI.

• Define an endpoint like POST /change_state.

• In the script, accept parameters (task_number, action), look up the task, and then call the same logic the UI Action does:

  (function process(request, response) { var taskNum = request.queryParams.task_number; var action = request.queryParams.action; // in_progress, close, cancel var task = new GlideRecord('sc_task'); if (task.get('number', taskNum)) { if (action == "in_progress") { task.state = 2; // In Progress // plus any extra logic UI Action does } else if (action == "close") { task.state = 3; // Closed Complete } else if (action == "cancel") { task.state = 4; // Closed Incomplete } task.update(); response.setBody({result: "Updated"}); } else { response.setBody({error: "Task not found"}); } })(request, response);

• From your external system, call this REST API instead of the Table API.

 

3. If absolutely required: direct Table API update (not recommended)

• You can force PATCH /api/now/table/sc_task with { "state": "3" }, if you disable/alter the protection Business Rule.

• But you’ll skip all the logic tied to the UI Action (like notifications, catalog item updates, or parent RITM closure).

• This risks data inconsistency. Only use if you truly don’t care about the workflows.

[ykara]

Hi Ravi

Is there not a way of just calling the UI Action buttons or triggering the associated workflow via the API?

There was hint in this post on doing this but the poster wanted to do it on the table level rather than the record level. I am looking to do it on the record (SC Task) level but not exactly sure how to make the API call