ComplianceControlsApi.md

ComplianceControlsApi

All URIs are relative to http://localhost/

Method	HTTP request	Description
list	PUT api/v2/compliance_controls.json_api	Get a list of Compliance Controls
listSignatures	GET api/v2/compliance_controls/{compliance_control_id}/signatures.json_api	Get a list of Signatures for a Compliance Control
show	GET api/v2/compliance_controls/{id}.json_api	Show a single Compliance Control

list

PaginatedCollection list(include, filter, page)

Get a list of Compliance Controls

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ComplianceControlsApi;


ComplianceControlsApi apiInstance = new ComplianceControlsApi();
String include = "include_example"; // String | Related objects that can be included in the response:  compliance_standard, compliance_domain, signatures See Including Objects for more information.
Map<String, String> filter = new HashMap(); // Map<String, String> | Filter Params for Searching.  Equality Searchable Attributes: [id, identifier, name] Matching Searchable Attributes: [identifier, name]  Sortable Attributes: [id, identifier, name, position] Searchable Associations: [compliance_standard, compliance_domain] 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.
String 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.
try {
    PaginatedCollection result = apiInstance.list(include, filter, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ComplianceControlsApi#list");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
include	String	Related objects that can be included in the response: compliance_standard, compliance_domain, signatures See Including Objects for more information.	[optional]
filter	Map<String, String>	Filter Params for Searching. Equality Searchable Attributes: [id, identifier, name] Matching Searchable Attributes: [identifier, name] Sortable Attributes: [id, identifier, name, position] Searchable Associations: [compliance_standard, compliance_domain] 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

No authorization required

HTTP request headers

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

listSignatures

PaginatedCollection listSignatures(complianceControlId, include, page)

Get a list of Signatures for a Compliance Control

The compliance standard must be paid for to view signatures for a control on that standard.

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ComplianceControlsApi;


ComplianceControlsApi apiInstance = new ComplianceControlsApi();
Integer complianceControlId = 56; // Integer | The ID of the Compliance Control this signature belongs to
String include = "include_example"; // String | Related objects that can be included in the response:  service, suppressions See Including Objects for more information.
String 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.
try {
    PaginatedCollection result = apiInstance.listSignatures(complianceControlId, include, page);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ComplianceControlsApi#listSignatures");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
complianceControlId	Integer	The ID of the Compliance Control this signature belongs to
include	String	Related objects that can be included in the response: service, suppressions See Including Objects 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

No authorization required

HTTP request headers

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

show

ComplianceControl show(id, include)

Show a single Compliance Control

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ComplianceControlsApi;


ComplianceControlsApi apiInstance = new ComplianceControlsApi();
Integer id = 56; // Integer | Compliance Control ID
String include = "include_example"; // String | Related objects that can be included in the response:  compliance_standard, compliance_domain, signatures See Including Objects for more information.
try {
    ComplianceControl result = apiInstance.show(id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ComplianceControlsApi#show");
    e.printStackTrace();
}

Parameters

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

Return type

ComplianceControl

Authorization

No authorization required

HTTP request headers

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