Dealing with Tasks

Updated on : January 22, 2025, 3:05 pm

---

Before dealing with tasks, you need to know JSON. I will certainly not give you lessons on what is a JavaScript Object Notation. But Google will explain everything you need to know about this lightweight data-interchange format.

A Task is all the informations a bridge needs to make his magic. Depending on the namespaces, each methods need some different kind of data to get the job done.

A process always begins by a Task Creation. Using POST method, send a task parameter in a valid JSON format;

Create a Task

[POST] curl https://api.fmsync.net/v2/{sourcekey}/{namespace}/{method}
-d task={task} sourcekey: Unique key that represent the source you've created under a client bridge.
namespace: Represent a unique identifier of the Software you need to request something.
method: Depending on the namespace, the method is the name of the function that will be called.

Request

Lets get the actual Balance of a customer in ACCEO Acomba [POST] curl https://api.fmsync.net/v2/78446d128e8c982fd7b7edd94c573b31dac0d2ea/acomba/balance
-d task=
{"linkid":12345,"code":"5537412"} Get the complete syntax of acomba.balance at https://fmsync.net/en/apiref/acomba/balance

Response

{
  success: true,
  message: null,
  taskid: "20a686bf4bab9df1b0f30c85842d2b556d9898e5",
  context: "task.create",
}

success BOOLEAN required	Task was created successfully.
message STRING	Message returned by Bridge. Required if success is FALSE.
taskid STRING	Unique Task auto-generated identifier. Required if success is TRUE.
context STRING	The context of the current request. Required if success is TRUE.
violations ARRAY	List of violations (string) if JSON is invalid.

---

Task Return

Now that your task has been created, we need to wait until the Agent do his job and return the informations back to you.

Processing time could be variable, depending on several things like server load, web connectivity or client server. But in general, it takes less than a few seconds.

The way the task will return to your Source depends on the type of connection you chose:

{
  success: true,
  message: null,
  taskid: "20a686bf4bab9df1b0f30c85842d2b556d9898e5",
  context: "acomba.balance",
  data: {
    balance: 10120.45
  }
}

success BOOLEAN required	Agent processed the task successfully.
message STRING	Message returned by the application if success return FALSE.
taskid STRING required	Unique Task auto-generated identifier.
context STRING required	The context of the current Task. Format: {namespace}.{method}
data OBJECT	Returned results by the agent.