ComplianceDomainsApi.md

ESP::ComplianceDomainsApi

All URIs are relative to https://api.evident.io

Method	HTTP request	Description
list	PUT /api/v2/compliance_domains.json_api	Get a list of Compliance Domains
show	GET /api/v2/compliance_domains/{id}.json_api	Show a single Compliance Domain

list

PaginatedCollection list(opts)

Get a list of Compliance Domains

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::ComplianceDomainsApi.new

opts = { 
  include: "include_example", # String | Related objects that can be included in the response:  compliance_standard, compliance_controls See Including Objects for more information.
  filter: {'key' => "filter_example"}, # Hash<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, position, identifier, name] Matching Searchable Attributes: [identifier, name]  Sortable Attributes: [id, identifier, name, position] Searchable Association: [compliance_standard] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.
  page: "{:number=>1,+:size=>20}" # String | Page Number and Page Size.  Number is the page number of the collection to return, size is the number of items to return per page.
}

begin
  #Get a list of Compliance Domains
  result = api_instance.list(opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling ComplianceDomainsApi->list: #{e}"
end

Parameters

Name	Type	Description	Notes
include	String	Related objects that can be included in the response: compliance_standard, compliance_controls See Including Objects for more information.	[optional]
filter	Hash<String, String>	Filter Params for Searching. Equality Searchable Attributes: [id, position, identifier, name] Matching Searchable Attributes: [identifier, name] Sortable Attributes: [id, identifier, name, position] Searchable Association: [compliance_standard] See Searching Lists for more information. See the filter parameter of the association's list action to see what attributes are searchable on each association. See Conditions on Relationships in Searching Lists for more information.	[optional]
page	String	Page Number and Page Size. Number is the page number of the collection to return, size is the number of items to return per page.	[optional] [default to {:number=>1,+:size=>20}]

Return type

PaginatedCollection

Authorization

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json

show

ComplianceDomain show(id, opts)

Show a single Compliance Domain

Example

# load the gem
require 'esp_sdk'

api_instance = ESP::ComplianceDomainsApi.new

id = 56 # Integer | Compliance Domain ID

opts = { 
  include: "include_example" # String | Related objects that can be included in the response:  compliance_standard, compliance_controls See Including Objects for more information.
}

begin
  #Show a single Compliance Domain
  result = api_instance.show(id, opts)
  p result
rescue ESP::ApiError => e
  puts "Exception when calling ComplianceDomainsApi->show: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer	Compliance Domain ID
include	String	Related objects that can be included in the response: compliance_standard, compliance_controls See Including Objects for more information.	[optional]

Return type

ComplianceDomain

Authorization

See https://github.com/EvidentSecurity/esp-sdk-ruby#set-your-hmac-security-keys

HTTP request headers

• Content-Type: application/vnd.api+json
• Accept: application/vnd.api+json