CustomComplianceStandardsApi.md

esp_sdk.CustomComplianceStandardsApi

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

Method	HTTP request	Description
create	POST /api/v2/custom_compliance_standards.json_api	Create a(n) Custom Compliance Standard
delete	DELETE /api/v2/custom_compliance_standards/{id}.json_api	Delete a(n) Custom Compliance Standard
show	GET /api/v2/custom_compliance_standards/{id}.json_api	Show a single Custom Compliance Standard
update	PATCH /api/v2/custom_compliance_standards/{id}.json_api	Update a(n) Custom Compliance Standard

create

CustomComplianceStandard create(description, name, include=include)

Create a(n) Custom Compliance Standard

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceStandardsApi()
description = 'description_example' # str | The description for this Compliance Standard
name = 'name_example' # str | Name
include = 'include_example' # str | Related objects that can be included in the response:  custom_compliance_domains, custom_compliance_controls See Including Objects for more information. (optional)

try: 
    # Create a(n) Custom Compliance Standard
    api_response = api_instance.create(description, name, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceStandardsApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
description	str	The description for this Compliance Standard
name	str	Name
include	str	Related objects that can be included in the response: custom_compliance_domains, custom_compliance_controls See Including Objects for more information.	[optional]

Return type

CustomComplianceStandard

Authorization

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

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

Meta delete(id)

Delete a(n) Custom Compliance Standard

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceStandardsApi()
id = 56 # int | Custom Compliance Standard ID

try: 
    # Delete a(n) Custom Compliance Standard
    api_response = api_instance.delete(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceStandardsApi->delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Custom Compliance Standard ID

Return type

Meta

Authorization

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

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

show

CustomComplianceStandard show(id, include=include)

Show a single Custom Compliance Standard

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceStandardsApi()
id = 56 # int | Custom Compliance Standard ID
include = 'include_example' # str | Related objects that can be included in the response:  custom_compliance_domains, custom_compliance_controls See Including Objects for more information. (optional)

try: 
    # Show a single Custom Compliance Standard
    api_response = api_instance.show(id, include=include)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceStandardsApi->show: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Custom Compliance Standard ID
include	str	Related objects that can be included in the response: custom_compliance_domains, custom_compliance_controls See Including Objects for more information.	[optional]

Return type

CustomComplianceStandard

Authorization

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

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

CustomComplianceStandard update(id, include=include, description=description, name=name)

Update a(n) Custom Compliance Standard

Example

from __future__ import print_statement
import time
import esp_sdk
from esp_sdk.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = esp_sdk.CustomComplianceStandardsApi()
id = 56 # int | Custom Compliance Standard ID
include = 'include_example' # str | Related objects that can be included in the response:  custom_compliance_domains, custom_compliance_controls See Including Objects for more information. (optional)
description = 'description_example' # str | The description for this Compliance Standard (optional)
name = 'name_example' # str | Name (optional)

try: 
    # Update a(n) Custom Compliance Standard
    api_response = api_instance.update(id, include=include, description=description, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomComplianceStandardsApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	Custom Compliance Standard ID
include	str	Related objects that can be included in the response: custom_compliance_domains, custom_compliance_controls See Including Objects for more information.	[optional]
description	str	The description for this Compliance Standard	[optional]
name	str	Name	[optional]

Return type

CustomComplianceStandard

Authorization

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

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]