FormanceV2

(Orchestration.V2)

Overview

Available Operations

GetServerInfo - Get server info
ListTriggers - List triggers
CreateTrigger - Create trigger
ReadTrigger - Read trigger
DeleteTrigger - Delete trigger
TestTrigger - Test trigger
ListTriggersOccurrences - List triggers occurrences
ListWorkflows - List registered workflows
CreateWorkflow - Create workflow
GetWorkflow - Get a flow by id
DeleteWorkflow - Delete a flow by id
RunWorkflow - Run workflow
ListInstances - List instances of a workflow
GetInstance - Get a workflow instance by id
SendEvent - Send an event to a running workflow
CancelEvent - Cancel a running workflow
GetInstanceHistory - Get a workflow instance history by id
GetInstanceStageHistory - Get a workflow instance stage history

GetServerInfo

Get server info

Example Usage

using formance;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.GetServerInfoAsync();

// handle response

Response

V2GetServerInfoResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

ListTriggers

List triggers

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.ListTriggersAsync(
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    pageSize: 100,
    name: "<value>"
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Cursor`	string	➖	Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.	aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
`PageSize`	long	➖	The maximum number of results to return per page.	100
`Name`	string	➖	search by name

Response

Models.Requests.V2ListTriggersResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

CreateTrigger

Create trigger

Example Usage

using formance;
using formance.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

V2TriggerData req = new V2TriggerData() {
    Event = "<value>",
    WorkflowID = "<id>",
};

var res = await sdk.Orchestration.V2.CreateTriggerAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	V2TriggerData	✔️	The request object to use for the request.

Response

Models.Requests.V2CreateTriggerResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

ReadTrigger

Read trigger

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.ReadTriggerAsync(triggerID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`TriggerID`	string	✔️	The trigger id

Response

Models.Requests.V2ReadTriggerResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

DeleteTrigger

Read trigger

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.DeleteTriggerAsync(triggerID: "<id>");

// handle response

Parameters

Parameter	Type	Required	Description
`TriggerID`	string	✔️	The trigger id

Response

V2DeleteTriggerResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

TestTrigger

Test trigger

Example Usage

using formance;
using formance.Models.Requests;
using System.Collections.Generic;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.TestTriggerAsync(
    triggerID: "<id>",
    requestBody: new Dictionary<string, object>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description
`TriggerID`	string	✔️	The trigger id
`RequestBody`	Dictionary<String, object>	➖	N/A

Response

TestTriggerResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

ListTriggersOccurrences

List triggers occurrences

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.ListTriggersOccurrencesAsync(
    triggerID: "<id>",
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    pageSize: 100
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`TriggerID`	string	✔️	The trigger id
`Cursor`	string	➖	Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.	aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
`PageSize`	long	➖	The maximum number of results to return per page.	100

Response

Models.Requests.V2ListTriggersOccurrencesResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

ListWorkflows

List registered workflows

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.ListWorkflowsAsync(
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    pageSize: 100
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Cursor`	string	➖	Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.	aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
`PageSize`	long	➖	The maximum number of results to return per page.	100

Response

Models.Requests.V2ListWorkflowsResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

CreateWorkflow

Create a workflow

Example Usage

using formance;
using formance.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

V2CreateWorkflowRequest req = new V2CreateWorkflowRequest() {
    Stages = new List<Dictionary<string, object>>() {
        new Dictionary<string, object>() {
            { "key", "<value>" },
        },
    },
};

var res = await sdk.Orchestration.V2.CreateWorkflowAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
`request`	V2CreateWorkflowRequest	✔️	The request object to use for the request.

Response

Models.Requests.V2CreateWorkflowResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

GetWorkflow

Get a flow by id

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.GetWorkflowAsync(flowId: "xxx");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`FlowId`	string	✔️	The flow id	xxx

Response

Models.Requests.V2GetWorkflowResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

DeleteWorkflow

Delete a flow by id

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.DeleteWorkflowAsync(flowId: "xxx");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`FlowId`	string	✔️	The flow id	xxx

Response

V2DeleteWorkflowResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

RunWorkflow

Run workflow

Example Usage

using formance;
using formance.Models.Requests;
using System.Collections.Generic;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.RunWorkflowAsync(
    workflowID: "xxx",
    wait: false,
    requestBody: new Dictionary<string, string>() {
        { "key", "<value>" },
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`WorkflowID`	string	✔️	The flow id	xxx
`Wait`	bool	➖	Wait end of the workflow before return
`RequestBody`	Dictionary<String, string>	➖	N/A

Response

Models.Requests.V2RunWorkflowResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

ListInstances

List instances of a workflow

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.ListInstancesAsync(
    cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
    pageSize: 100,
    workflowID: "xxx",
    running: true
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`Cursor`	string	➖	Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.	aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
`PageSize`	long	➖	The maximum number of results to return per page.	100
`WorkflowID`	string	➖	A workflow id	xxx
`Running`	bool	➖	Filter running instances	true

Response

V2ListInstancesResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

GetInstance

Get a workflow instance by id

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.GetInstanceAsync(instanceID: "xxx");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`InstanceID`	string	✔️	The instance id	xxx

Response

V2GetInstanceResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

SendEvent

Send an event to a running workflow

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.SendEventAsync(
    instanceID: "xxx",
    requestBody: new V2SendEventRequestBody() {
        Name = "<value>",
    }
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`InstanceID`	string	✔️	The instance id	xxx
`RequestBody`	V2SendEventRequestBody	➖	N/A

Response

V2SendEventResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

CancelEvent

Cancel a running workflow

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.CancelEventAsync(instanceID: "xxx");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`InstanceID`	string	✔️	The instance id	xxx

Response

V2CancelEventResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

GetInstanceHistory

Get a workflow instance history by id

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.GetInstanceHistoryAsync(instanceID: "xxx");

// handle response

Parameters

Parameter	Type	Required	Description	Example
`InstanceID`	string	✔️	The instance id	xxx

Response

V2GetInstanceHistoryResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

GetInstanceStageHistory

Get a workflow instance stage history

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Orchestration.V2.GetInstanceStageHistoryAsync(
    instanceID: "xxx",
    number: 0
);

// handle response

Parameters

Parameter	Type	Required	Description	Example
`InstanceID`	string	✔️	The instance id	xxx
`Number`	long	✔️	The stage number	0

Response

V2GetInstanceStageHistoryResponse

Errors

Error Type	Status Code	Content Type
formance.Models.Errors.V2Error	default	application/json
formance.Models.Errors.SDKException	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

FormanceV2

Overview

Available Operations

GetServerInfo

Example Usage

Response

Errors

ListTriggers

Example Usage

Parameters

Response

Errors

CreateTrigger

Example Usage

Parameters

Response

Errors

ReadTrigger

Example Usage

Parameters

Response

Errors

DeleteTrigger

Example Usage

Parameters

Response

Errors

TestTrigger

Example Usage

Parameters

Response

Errors

ListTriggersOccurrences

Example Usage

Parameters

Response

Errors

ListWorkflows

Example Usage

Parameters

Response

Errors

CreateWorkflow

Example Usage

Parameters

Response

Errors

GetWorkflow

Example Usage

Parameters

Response

Errors

DeleteWorkflow

Example Usage

Parameters

Response

Errors

RunWorkflow

Example Usage

Parameters

Response

Errors

ListInstances

Example Usage

Parameters

Response

Errors

GetInstance

Example Usage

Parameters

Response

Errors

SendEvent

Example Usage