Skip to content

Latest commit

 

History

History
297 lines (207 loc) · 9.2 KB

ObjectPermissionApi.md

File metadata and controls

297 lines (207 loc) · 9.2 KB

EzmaxApi::ObjectPermissionApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
permission_create_object_v1 POST /1/object/permission Create a new Permission
permission_delete_object_v1 DELETE /1/object/permission/{pkiPermissionID} Delete an existing Permission
permission_edit_object_v1 PUT /1/object/permission/{pkiPermissionID} Edit an existing Permission
permission_get_object_v2 GET /2/object/permission/{pkiPermissionID} Retrieve an existing Permission

permission_create_object_v1

permission_create_object_v1(permission_create_object_v1_request)

Create a new Permission

The endpoint allows to create one or many elements at once.

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectPermissionApi.new
permission_create_object_v1_request = EzmaxApi::PermissionCreateObjectV1Request.new({a_obj_permission: [EzmaxApi::PermissionRequestCompound.new({fki_modulesection_id: 53})]}) # PermissionCreateObjectV1Request | 

begin
  # Create a new Permission
  result = api_instance.permission_create_object_v1(permission_create_object_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_create_object_v1: #{e}"
end

Using the permission_create_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> permission_create_object_v1_with_http_info(permission_create_object_v1_request)

begin
  # Create a new Permission
  data, status_code, headers = api_instance.permission_create_object_v1_with_http_info(permission_create_object_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PermissionCreateObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_create_object_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
permission_create_object_v1_request PermissionCreateObjectV1Request

Return type

PermissionCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

permission_delete_object_v1

permission_delete_object_v1(pki_permission_id)

Delete an existing Permission

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectPermissionApi.new
pki_permission_id = 56 # Integer | The unique ID of the Permission

begin
  # Delete an existing Permission
  result = api_instance.permission_delete_object_v1(pki_permission_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_delete_object_v1: #{e}"
end

Using the permission_delete_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> permission_delete_object_v1_with_http_info(pki_permission_id)

begin
  # Delete an existing Permission
  data, status_code, headers = api_instance.permission_delete_object_v1_with_http_info(pki_permission_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PermissionDeleteObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_delete_object_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_permission_id Integer The unique ID of the Permission

Return type

PermissionDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

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

permission_edit_object_v1

permission_edit_object_v1(pki_permission_id, permission_edit_object_v1_request)

Edit an existing Permission

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectPermissionApi.new
pki_permission_id = 56 # Integer | The unique ID of the Permission
permission_edit_object_v1_request = EzmaxApi::PermissionEditObjectV1Request.new({obj_permission: EzmaxApi::PermissionRequestCompound.new({fki_modulesection_id: 53})}) # PermissionEditObjectV1Request | 

begin
  # Edit an existing Permission
  result = api_instance.permission_edit_object_v1(pki_permission_id, permission_edit_object_v1_request)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_edit_object_v1: #{e}"
end

Using the permission_edit_object_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> permission_edit_object_v1_with_http_info(pki_permission_id, permission_edit_object_v1_request)

begin
  # Edit an existing Permission
  data, status_code, headers = api_instance.permission_edit_object_v1_with_http_info(pki_permission_id, permission_edit_object_v1_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PermissionEditObjectV1Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_edit_object_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_permission_id Integer The unique ID of the Permission
permission_edit_object_v1_request PermissionEditObjectV1Request

Return type

PermissionEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

permission_get_object_v2

permission_get_object_v2(pki_permission_id)

Retrieve an existing Permission

Examples

require 'time'
require 'Ezmaxapi'
# setup authorization
EzmaxApi.configure do |config|
  # Configure API key authorization: Authorization
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = EzmaxApi::ObjectPermissionApi.new
pki_permission_id = 56 # Integer | The unique ID of the Permission

begin
  # Retrieve an existing Permission
  result = api_instance.permission_get_object_v2(pki_permission_id)
  p result
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_get_object_v2: #{e}"
end

Using the permission_get_object_v2_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> permission_get_object_v2_with_http_info(pki_permission_id)

begin
  # Retrieve an existing Permission
  data, status_code, headers = api_instance.permission_get_object_v2_with_http_info(pki_permission_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PermissionGetObjectV2Response>
rescue EzmaxApi::ApiError => e
  puts "Error when calling ObjectPermissionApi->permission_get_object_v2_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
pki_permission_id Integer The unique ID of the Permission

Return type

PermissionGetObjectV2Response

Authorization

Authorization

HTTP request headers

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