GroupsApi.md

IronWorker::GroupsApi

All URIs are relative to https://localhost:8080/v1

Method	HTTP request	Description
groups_get	GET /groups	Get all group names.
groups_name_get	GET /groups/{name}	Get information for a group.
groups_name_put	PUT /groups/{name}	Create/update a task group.
groups_post	POST /groups	Post new group

groups_get

GroupsWrapper groups_get

Get all group names.

Get a list of all the groups in the system.

Example

# load the gem
require 'worker_ruby'

api_instance = IronWorker::GroupsApi.new

begin
  #Get all group names.
  result = api_instance.groups_get
  p result
rescue IronWorker::ApiError => e
  puts "Exception when calling GroupsApi->groups_get: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

GroupsWrapper

Authorization

No authorization required

HTTP request headers

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

groups_name_get

GroupWrapper groups_name_get(name)

Get information for a group.

This gives more details about a task group, such as statistics.

Example

# load the gem
require 'worker_ruby'

api_instance = IronWorker::GroupsApi.new

name = "name_example" # String | name of the group.


begin
  #Get information for a group.
  result = api_instance.groups_name_get(name)
  p result
rescue IronWorker::ApiError => e
  puts "Exception when calling GroupsApi->groups_name_get: #{e}"
end

Parameters

Name	Type	Description	Notes
name	String	name of the group.

Return type

GroupWrapper

Authorization

No authorization required

HTTP request headers

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

groups_name_put

GroupWrapper groups_name_put(name, body)

Create/update a task group.

You can set group level settings here.

Example

# load the gem
require 'worker_ruby'

api_instance = IronWorker::GroupsApi.new

name = "name_example" # String | name of the group.

body = IronWorker::GroupWrapper.new # GroupWrapper | Group to post.


begin
  #Create/update a task group.
  result = api_instance.groups_name_put(name, body)
  p result
rescue IronWorker::ApiError => e
  puts "Exception when calling GroupsApi->groups_name_put: #{e}"
end

Parameters

Name	Type	Description	Notes
name	String	name of the group.
body	GroupWrapper	Group to post.

Return type

GroupWrapper

Authorization

No authorization required

HTTP request headers

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

groups_post

GroupWrapper groups_post(body)

Post new group

Insert a new task group

Example

# load the gem
require 'worker_ruby'

api_instance = IronWorker::GroupsApi.new

body = IronWorker::GroupWrapper.new # GroupWrapper | Group to post.


begin
  #Post new group
  result = api_instance.groups_post(body)
  p result
rescue IronWorker::ApiError => e
  puts "Exception when calling GroupsApi->groups_post: #{e}"
end

Parameters

Name	Type	Description	Notes
body	GroupWrapper	Group to post.

Return type

GroupWrapper

Authorization

No authorization required

HTTP request headers

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