Skip to content

Latest commit

 

History

History
166 lines (124 loc) · 5.57 KB

TasksApi.md

File metadata and controls

166 lines (124 loc) · 5.57 KB

ProcessMakerSDK.Api.TasksApi

All URIs are relative to http://localhost/api/1.0

Method HTTP request Description
GetTasks GET /tasks Returns all tasks that the user has access to
UpdateTask PUT /tasks/{task_id} Update a task

GetTasks

InlineResponse20018 GetTasks (int? processRequestId = null, string filter = null, string orderBy = null, string orderDirection = null)

Returns all tasks that the user has access to

Example

using System.Diagnostics;
using ProcessMakerSDK.Api;
using ProcessMakerSDK.Client;
using ProcessMakerSDK.Model;

namespace Example
{
    public class GetTasksExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost/api/1.0";
            // Configure OAuth2 access token for authorization: pm_api_auth_code
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure API key authorization: pm_api_key
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new TasksApi(Configuration.Default);
            var processRequestId = 56;  // int? | Process request id (optional) 
            var filter = filter_example;  // string | Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring. (optional) 
            var orderBy = orderBy_example;  // string | Field to order results by (optional) 
            var orderDirection = orderDirection_example;  // string |  (optional)  (default to asc)

            try
            {
                // Returns all tasks that the user has access to
                InlineResponse20018 result = apiInstance.GetTasks(processRequestId, filter, orderBy, orderDirection);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling TasksApi.GetTasks: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
processRequestId int? Process request id [optional]
filter string Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring. [optional]
orderBy string Field to order results by [optional]
orderDirection string [optional] [default to asc]

Return type

InlineResponse20018

Authorization

pm_api_auth_code, pm_api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTask

ProcessRequestToken UpdateTask (string taskId, ProcessRequestTokenEditable processRequestTokenEditable)

Update a task

Example

using System.Diagnostics;
using ProcessMakerSDK.Api;
using ProcessMakerSDK.Client;
using ProcessMakerSDK.Model;

namespace Example
{
    public class UpdateTaskExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "http://localhost/api/1.0";
            // Configure OAuth2 access token for authorization: pm_api_auth_code
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure API key authorization: pm_api_key
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new TasksApi(Configuration.Default);
            var taskId = taskId_example;  // string | ID of task to update
            var processRequestTokenEditable = new ProcessRequestTokenEditable(); // ProcessRequestTokenEditable | 

            try
            {
                // Update a task
                ProcessRequestToken result = apiInstance.UpdateTask(taskId, processRequestTokenEditable);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling TasksApi.UpdateTask: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
taskId string ID of task to update
processRequestTokenEditable ProcessRequestTokenEditable

Return type

ProcessRequestToken

Authorization

pm_api_auth_code, pm_api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]