ProcessMakerSDK.Api.GroupMembersApi

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

Method	HTTP request	Description
CreateGroupMember	POST /group_members	Save a new group member
DeleteGroupMember	DELETE /group_members/{group_member_id}	Delete a group member
GetGroupMemberById	GET /group_members/{group_member_id}	Get single group member by ID
GetGroupMembers	GET /group_members	Returns all groups for a given member
GetGroupMembersAvailable	GET /group_members_available	Returns all groups available for a given member
GetUserMembersAvailable	GET /user_members_available	Returns all users available for a given member

CreateGroupMember

GroupMembers CreateGroupMember (GroupMembersEditable groupMembersEditable)

Save a new group member

Example

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

namespace Example
{
    public class CreateGroupMemberExample
    {
        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 GroupMembersApi(Configuration.Default);
            var groupMembersEditable = new GroupMembersEditable(); // GroupMembersEditable | 

            try
            {
                // Save a new group member
                GroupMembers result = apiInstance.CreateGroupMember(groupMembersEditable);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling GroupMembersApi.CreateGroupMember: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
groupMembersEditable	GroupMembersEditable

Return type

GroupMembers

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]

DeleteGroupMember

GroupMembers DeleteGroupMember (string groupMemberId)

Delete a group member

Example

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

namespace Example
{
    public class DeleteGroupMemberExample
    {
        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 GroupMembersApi(Configuration.Default);
            var groupMemberId = groupMemberId_example;  // string | ID of group_members to return

            try
            {
                // Delete a group member
                GroupMembers result = apiInstance.DeleteGroupMember(groupMemberId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling GroupMembersApi.DeleteGroupMember: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
groupMemberId	string	ID of group_members to return

Return type

GroupMembers

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]

GetGroupMemberById

GroupMembers GetGroupMemberById (string groupMemberId)

Get single group member by ID

Example

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

namespace Example
{
    public class GetGroupMemberByIdExample
    {
        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 GroupMembersApi(Configuration.Default);
            var groupMemberId = groupMemberId_example;  // string | ID of group members to return

            try
            {
                // Get single group member by ID
                GroupMembers result = apiInstance.GetGroupMemberById(groupMemberId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling GroupMembersApi.GetGroupMemberById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
groupMemberId	string	ID of group members to return

Return type

GroupMembers

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]

GetGroupMembers

InlineResponse2007 GetGroupMembers (int? memberId = null, string orderBy = null, string orderDirection = null, int? perPage = null)

Returns all groups for a given member

Example

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

namespace Example
{
    public class GetGroupMembersExample
    {
        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 GroupMembersApi(Configuration.Default);
            var memberId = 56;  // int? |  (optional) 
            var orderBy = orderBy_example;  // string | Field to order results by (optional) 
            var orderDirection = orderDirection_example;  // string |  (optional)  (default to asc)
            var perPage = 56;  // int? |  (optional) 

            try
            {
                // Returns all groups for a given member
                InlineResponse2007 result = apiInstance.GetGroupMembers(memberId, orderBy, orderDirection, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling GroupMembersApi.GetGroupMembers: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
memberId	int?		[optional]
orderBy	string	Field to order results by	[optional]
orderDirection	string		[optional] [default to asc]
perPage	int?		[optional]

Return type

InlineResponse2007

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]

GetGroupMembersAvailable

InlineResponse2008 GetGroupMembersAvailable (string memberId, string memberType, string filter = null, string orderBy = null, string orderDirection = null, int? perPage = null)

Returns all groups available for a given member

Example

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

namespace Example
{
    public class GetGroupMembersAvailableExample
    {
        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 GroupMembersApi(Configuration.Default);
            var memberId = memberId_example;  // string | ID of group member to return
            var memberType = memberType_example;  // string | type of group member to return
            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)
            var perPage = 56;  // int? |  (optional) 

            try
            {
                // Returns all groups available for a given member
                InlineResponse2008 result = apiInstance.GetGroupMembersAvailable(memberId, memberType, filter, orderBy, orderDirection, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling GroupMembersApi.GetGroupMembersAvailable: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
memberId	string	ID of group member to return
memberType	string	type of group member to return
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]
perPage	int?		[optional]

Return type

InlineResponse2008

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]

GetUserMembersAvailable

InlineResponse2009 GetUserMembersAvailable (string groupId, string filter = null, string orderBy = null, string orderDirection = null, int? perPage = null)

Returns all users available for a given member

Example

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

namespace Example
{
    public class GetUserMembersAvailableExample
    {
        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 GroupMembersApi(Configuration.Default);
            var groupId = groupId_example;  // string | ID of group to return
            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)
            var perPage = 56;  // int? |  (optional) 

            try
            {
                // Returns all users available for a given member
                InlineResponse2009 result = apiInstance.GetUserMembersAvailable(groupId, filter, orderBy, orderDirection, perPage);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling GroupMembersApi.GetUserMembersAvailable: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
groupId	string	ID of group to return
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]
perPage	int?		[optional]

Return type

InlineResponse2009

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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ProcessMakerSDK.Api.GroupMembersApi

CreateGroupMember

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteGroupMember

Example

Parameters

Return type

Authorization

HTTP request headers

GetGroupMemberById

Example

Parameters

Return type

Authorization

HTTP request headers

GetGroupMembers

Example

Parameters

Return type

Authorization

HTTP request headers

GetGroupMembersAvailable

Example

Parameters

Return type

Authorization

HTTP request headers

GetUserMembersAvailable

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

GroupMembersApi.md

Latest commit

History

GroupMembersApi.md

File metadata and controls

ProcessMakerSDK.Api.GroupMembersApi

CreateGroupMember

Example

Parameters

Return type

Authorization

HTTP request headers

DeleteGroupMember

Example

Parameters

Return type

Authorization

HTTP request headers

GetGroupMemberById

Example

Parameters

Return type

Authorization

HTTP request headers

GetGroupMembers

Example

Parameters

Return type

Authorization

HTTP request headers

GetGroupMembersAvailable

Example

Parameters

Return type

Authorization

HTTP request headers

GetUserMembersAvailable

Example

Parameters

Return type

Authorization

HTTP request headers